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"
15 #ifndef VMG_PERL_PATCHLEVEL
17 # define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
19 # define VMG_PERL_PATCHLEVEL 0
23 #define VMG_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
25 #define VMG_HAS_PERL_BRANCH(R, V, S) (PERL_REVISION == (R) && PERL_VERSION == (V) && PERL_SUBVERSION >= (S))
27 #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))))
29 /* --- Threads and multiplicity -------------------------------------------- */
39 /* Safe unless stated otherwise in Makefile.PL */
41 # define VMG_FORKSAFE 1
44 #ifndef VMG_MULTIPLICITY
45 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
46 # define VMG_MULTIPLICITY 1
48 # define VMG_MULTIPLICITY 0
51 #if VMG_MULTIPLICITY && !defined(tTHX)
52 # define tTHX PerlInterpreter*
55 #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))
56 # define VMG_THREADSAFE 1
58 # define MY_CXT_CLONE \
60 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
61 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
62 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
65 # define VMG_THREADSAFE 0
67 # define dMY_CXT dNOOP
69 # define MY_CXT vmg_globaldata
71 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
73 # define MY_CXT_INIT NOOP
75 # define MY_CXT_CLONE NOOP
80 STATIC SV *vmg_clone(pTHX_ SV *sv, tTHX owner) {
81 #define vmg_clone(P, O) vmg_clone(aTHX_ (P), (O))
84 param.stashes = NULL; /* don't need it unless sv is a PVHV */
86 param.proto_perl = owner;
88 return SvREFCNT_inc(sv_dup(sv, ¶m));
91 #endif /* VMG_THREADSAFE */
93 /* --- Compatibility ------------------------------------------------------- */
96 # define Newx(v, n, c) New(0, v, n, c)
100 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
104 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
108 # define SvPV_const SvPV
111 #ifndef PERL_MAGIC_ext
112 # define PERL_MAGIC_ext '~'
115 #ifndef PERL_MAGIC_tied
116 # define PERL_MAGIC_tied 'P'
131 #ifndef IN_PERL_COMPILETIME
132 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
135 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
136 # ifndef PL_error_count
137 # define PL_error_count PL_parser->error_count
140 # ifndef PL_error_count
141 # define PL_error_count PL_Ierror_count
145 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but only
146 * enable it on 5.10 */
147 #if VMG_HAS_PERL(5, 10, 0)
153 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
154 * reverted to dev-5.11 as 9cdcb38b */
155 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
156 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
157 /* This branch should only apply for perls before the official 5.11.0 release.
158 * Makefile.PL takes care of the higher ones. */
159 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
161 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
162 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
165 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
166 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
168 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
169 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
173 /* Applied to dev-5.11 as 34908 */
174 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
175 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
177 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
180 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
181 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
182 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
184 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
187 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
188 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
190 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
195 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
196 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
197 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
199 sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
200 /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
201 if ((mg = SvMAGIC(sv))) {
204 const MGVTBL* const vtbl = mg->mg_virtual;
206 if (vtbl->svt_clear) {
211 } while ((mg = mg->mg_moremagic));
215 #endif /* VMG_UVAR */
217 /* --- Stolen chunk of B --------------------------------------------------- */
235 STATIC const char *const vmg_opclassnames[] = {
250 STATIC opclass vmg_opclass(const OP *o) {
257 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
259 if (o->op_type == OP_SASSIGN)
260 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
262 if (o->op_type == OP_AELEMFAST) {
263 if (o->op_flags & OPf_SPECIAL)
274 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
278 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
295 case OA_PVOP_OR_SVOP:
296 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
301 case OA_BASEOP_OR_UNOP:
302 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
304 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
306 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
308 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
311 if (o->op_flags & OPf_STACKED)
313 else if (o->op_flags & OPf_SPECIAL)
322 /* --- Error messages ------------------------------------------------------ */
324 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
325 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
326 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
328 /* --- Signatures ---------------------------------------------------------- */
330 #define SIG_WZO ((U16) (0x3891))
331 #define SIG_WIZ ((U16) (0x3892))
333 /* --- MGWIZ structure ----------------------------------------------------- */
342 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
345 #endif /* MGf_COPY */
351 #endif /* MGf_LOCAL */
353 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
354 #endif /* VMG_UVAR */
358 #endif /* VMG_MULTIPLICITY */
361 STATIC void vmg_mgwiz_free(pTHX_ MGWIZ *w) {
362 #define vmg_mgwiz_free(W) vmg_mgwiz_free(aTHX_ (W))
366 if (w->cb_data) SvREFCNT_dec(SvRV(w->cb_data));
367 if (w->cb_get) SvREFCNT_dec(SvRV(w->cb_get));
368 if (w->cb_set) SvREFCNT_dec(SvRV(w->cb_set));
369 if (w->cb_len) SvREFCNT_dec(SvRV(w->cb_len));
370 if (w->cb_clear) SvREFCNT_dec(SvRV(w->cb_clear));
371 if (w->cb_free) SvREFCNT_dec(SvRV(w->cb_free));
373 if (w->cb_copy) SvREFCNT_dec(SvRV(w->cb_copy));
374 #endif /* MGf_COPY */
376 if (w->cb_dup) SvREFCNT_dec(SvRV(w->cb_dup));
379 if (w->cb_local) SvREFCNT_dec(SvRV(w->cb_local));
380 #endif /* MGf_LOCAL */
382 if (w->cb_fetch) SvREFCNT_dec(SvRV(w->cb_fetch));
383 if (w->cb_store) SvREFCNT_dec(SvRV(w->cb_store));
384 if (w->cb_exists) SvREFCNT_dec(SvRV(w->cb_exists));
385 if (w->cb_delete) SvREFCNT_dec(SvRV(w->cb_delete));
386 #endif /* VMG_UVAR */
396 #define VMG_CLONE_CB(N) \
397 z->cb_ ## N = (w->cb_ ## N) ? newRV_noinc(vmg_clone(SvRV(w->cb_ ## N), \
401 STATIC MGWIZ *vmg_mgwiz_clone(pTHX_ const MGWIZ *w) {
402 #define vmg_mgwiz_clone(W) vmg_mgwiz_clone(aTHX_ (W))
410 Copy(w->vtbl, t, 1, MGVTBL);
416 z->opinfo = w->opinfo;
426 #endif /* MGf_COPY */
432 #endif /* MGf_LOCAL */
436 VMG_CLONE_CB(exists);
437 VMG_CLONE_CB(delete);
438 #endif /* VMG_UVAR */
445 #endif /* VMG_THREADSAFE */
447 /* --- Context-safe global data -------------------------------------------- */
451 #define PTABLE_NAME ptable
452 #define PTABLE_VAL_FREE(V) vmg_mgwiz_free(V)
461 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
462 #define ptable_clear(T) ptable_clear(aTHX_ (T))
463 #define ptable_free(T) ptable_free(aTHX_ (T))
465 #endif /* VMG_THREADSAFE */
467 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
474 HV *b__op_stashes[OPc_MAX];
481 STATIC void vmg_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
485 if (ud->owner == aTHX)
488 w = vmg_mgwiz_clone(ent->val);
490 ptable_store(ud->wizards, ent->key, w);
493 #endif /* VMG_THREADSAFE */
495 /* --- Wizard objects ------------------------------------------------------ */
497 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg);
499 STATIC MGVTBL vmg_wizard_vtbl = {
504 vmg_wizard_free, /* free */
507 #endif /* MGf_COPY */
513 #endif /* MGf_LOCAL */
516 /* ... Wizard constructor .................................................. */
518 STATIC SV *vmg_wizard_new(pTHX_ const MGWIZ *w) {
519 #define vmg_wizard_new(W) vmg_wizard_new(aTHX_ (W))
520 SV *wiz = newSVuv(PTR2UV(w));
523 MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
524 mg->mg_private = SIG_WZO;
531 STATIC SV *vmg_wizard_validate(pTHX_ SV *wiz) {
532 #define vmg_wizard_validate(W) vmg_wizard_validate(aTHX_ (W))
539 croak(vmg_invalid_wiz);
542 #define vmg_wizard_id(W) SvUV((SV *) (W))
543 #define vmg_wizard_main_mgwiz(W) INT2PTR(const MGWIZ *, vmg_wizard_id(W))
545 /* ... Wizard destructor ................................................... */
547 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg) {
550 if (PL_dirty) /* During global destruction, the context is already freed */
553 w = (MGWIZ *) vmg_wizard_main_mgwiz(sv);
558 ptable_store(MY_CXT.wizards, w, NULL);
560 #else /* VMG_THREADSAFE */
562 #endif /* !VMG_THREADSAFE */
569 STATIC const MGWIZ *vmg_wizard_mgwiz(pTHX_ SV *wiz) {
570 #define vmg_wizard_mgwiz(W) vmg_wizard_mgwiz(aTHX_ ((SV *) (W)))
573 w = vmg_wizard_main_mgwiz(wiz);
574 if (w->owner == aTHX)
579 return ptable_fetch(MY_CXT.wizards, w);
583 #else /* VMG_THREADSAFE */
585 #define vmg_wizard_mgwiz(W) vmg_wizard_main_mgwiz(W)
587 #endif /* !VMG_THREADSAFE */
589 /* --- User-level functions implementation --------------------------------- */
591 STATIC const MAGIC *vmg_find(pTHX_ const SV *sv, SV *wiz) {
592 #define vmg_find(S, W) vmg_find(aTHX_ (S), (W))
593 const MAGIC *mg, *moremagic;
596 if (SvTYPE(sv) < SVt_PVMG)
599 wid = vmg_wizard_id(wiz);
600 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
601 moremagic = mg->mg_moremagic;
602 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
603 UV zid = vmg_wizard_id(mg->mg_ptr);
612 /* ... Construct private data .............................................. */
614 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
615 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
617 I32 i, alen = (args == NULL) ? 0 : av_len(args);
625 EXTEND(SP, alen + 1);
626 PUSHs(sv_2mortal(newRV_inc(sv)));
627 for (i = 0; i < alen; ++i)
628 PUSHs(*av_fetch(args, i, 0));
631 call_sv(ctor, G_SCALAR);
635 #if VMG_HAS_PERL(5, 8, 3)
636 SvREFCNT_inc(nsv); /* Or it will be destroyed in FREETMPS */
638 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
648 STATIC SV *vmg_data_get(pTHX_ SV *sv, SV *wiz) {
649 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
650 const MAGIC *mg = vmg_find(sv, wiz);
651 return mg ? mg->mg_obj : NULL;
654 /* ... Magic cast/dispell .................................................. */
657 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
659 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
661 prevmagic->mg_moremagic = moremagic;
663 SvMAGIC_set(sv, moremagic);
665 mg->mg_moremagic = NULL;
666 Safefree(mg->mg_ptr);
669 #endif /* VMG_UVAR */
671 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
672 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
673 MAGIC *mg, *moremagic = NULL;
678 if (vmg_find(sv, wiz))
681 w = vmg_wizard_mgwiz(wiz);
682 oldgmg = SvGMAGICAL(sv);
684 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
685 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
686 mg->mg_private = SIG_WIZ;
689 mg->mg_flags |= MGf_COPY;
690 #endif /* MGf_COPY */
693 mg->mg_flags |= MGf_DUP;
697 mg->mg_flags |= MGf_LOCAL;
698 #endif /* MGf_LOCAL */
700 if (SvTYPE(sv) < SVt_PVHV)
703 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
704 * magic is actually never called for them. If the GMAGICAL flag was off before
705 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
706 * now on, then this wizard has get magic. Hence we can work around the
707 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
708 * has uvar callbacks, it will be turned back on later. */
709 if (!oldgmg && SvGMAGICAL(sv))
717 uf[0].uf_val = vmg_svt_val;
724 /* One uvar magic in the chain is enough. */
725 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
726 moremagic = mg->mg_moremagic;
727 if (mg->mg_type == PERL_MAGIC_uvar)
731 if (mg) { /* Found another uvar magic. */
732 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
733 if (olduf->uf_val == vmg_svt_val) {
734 /* It's our uvar magic, nothing to do. oldgmg was true. */
737 /* It's another uvar magic, backup it and replace it by ours. */
739 vmg_uvar_del(sv, prevmagic, mg, moremagic);
743 vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
744 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
745 * handled by our uvar callback. */
747 #endif /* VMG_UVAR */
753 STATIC UV vmg_dispell(pTHX_ SV *sv, SV *wiz) {
754 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
757 #endif /* VMG_UVAR */
758 MAGIC *mg, *prevmagic, *moremagic = NULL;
759 UV wid = vmg_wizard_id(wiz);
761 if (SvTYPE(sv) < SVt_PVMG)
764 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
765 moremagic = mg->mg_moremagic;
766 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
767 const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
768 UV zid = vmg_wizard_id(mg->mg_ptr);
771 /* If the current has no uvar, short-circuit uvar deletion. */
772 uvars = z->uvar ? (uvars + 1) : 0;
773 #endif /* VMG_UVAR */
776 } else if (z->uvar) {
778 /* We can't break here since we need to find the ext magic to delete. */
779 #endif /* VMG_UVAR */
787 prevmagic->mg_moremagic = moremagic;
789 SvMAGIC_set(sv, moremagic);
791 mg->mg_moremagic = NULL;
793 /* Destroy private data */
794 if (mg->mg_obj != sv)
795 SvREFCNT_dec(mg->mg_obj);
796 /* Unreference the wizard */
797 SvREFCNT_dec((SV *) mg->mg_ptr);
801 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
802 /* mg was the first ext magic in the chain that had uvar */
804 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
805 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
806 const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
816 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
817 moremagic = mg->mg_moremagic;
818 if (mg->mg_type == PERL_MAGIC_uvar)
822 uf = (struct ufuncs *) mg->mg_ptr;
823 /* assert(uf->uf_val == vmg_svt_val); */
824 if (uf[1].uf_val || uf[1].uf_set) {
825 /* Revert the original uvar magic. */
827 Renew(uf, 1, struct ufuncs);
828 mg->mg_ptr = (char *) uf;
829 mg->mg_len = sizeof(struct ufuncs);
831 /* Remove the uvar magic. */
832 vmg_uvar_del(sv, prevmagic, mg, moremagic);
836 #endif /* VMG_UVAR */
841 /* ... OP info ............................................................. */
843 #define VMG_OP_INFO_NAME 1
844 #define VMG_OP_INFO_OBJECT 2
847 STATIC perl_mutex vmg_op_name_init_mutex;
850 STATIC U32 vmg_op_name_init = 0;
851 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
853 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
854 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
856 case VMG_OP_INFO_NAME:
858 MUTEX_LOCK(&vmg_op_name_init_mutex);
860 if (!vmg_op_name_init) {
862 for (t = 0; t < OP_max; ++t)
863 vmg_op_name_len[t] = strlen(PL_op_name[t]);
864 vmg_op_name_init = 1;
867 MUTEX_UNLOCK(&vmg_op_name_init_mutex);
870 case VMG_OP_INFO_OBJECT: {
872 if (!MY_CXT.b__op_stashes[0]) {
875 for (c = 0; c < OPc_MAX; ++c)
876 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
885 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
886 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
891 case VMG_OP_INFO_NAME: {
892 OPCODE t = PL_op->op_type;
893 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
895 case VMG_OP_INFO_OBJECT: {
897 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
898 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
907 /* ... svt callbacks ....................................................... */
909 #define VMG_CB_CALL_SET_RET(D) \
914 ret = SvOK(svr) ? SvIV(svr) : (D); \
918 #define VMG_CB_CALL_ARGS_MASK 15
919 #define VMG_CB_CALL_ARGS_SHIFT 4
920 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
922 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
925 unsigned int i, args, opinfo;
929 args = flags & VMG_CB_CALL_ARGS_MASK;
930 flags >>= VMG_CB_CALL_ARGS_SHIFT;
931 opinfo = flags & VMG_CB_CALL_OPINFO;
937 EXTEND(SP, args + 1);
938 PUSHs(sv_2mortal(newRV_inc(sv)));
940 for (i = 0; i < args; ++i) {
941 SV *sva = va_arg(ap, SV *);
942 PUSHs(sva ? sva : &PL_sv_undef);
946 XPUSHs(vmg_op_info(opinfo));
949 call_sv(cb, G_SCALAR);
951 VMG_CB_CALL_SET_RET(0);
959 #define vmg_cb_call1(I, F, S, A1) \
960 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
961 #define vmg_cb_call2(I, F, S, A1, A2) \
962 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
963 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
964 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
966 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
967 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
968 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
971 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
972 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
973 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
976 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
977 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
978 unsigned int opinfo = w->opinfo;
980 svtype t = SvTYPE(sv);
989 PUSHs(sv_2mortal(newRV_inc(sv)));
990 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
993 U8 *s = (U8 *) SvPV_const(sv, l);
995 len = utf8_length(s, s + l);
999 } else if (t == SVt_PVAV) {
1000 len = av_len((AV *) sv) + 1;
1004 PUSHs(&PL_sv_undef);
1007 XPUSHs(vmg_op_info(opinfo));
1010 call_sv(w->cb_len, G_SCALAR);
1012 VMG_CB_CALL_SET_RET(len);
1017 return t == SVt_PVAV ? ret - 1 : ret;
1020 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1021 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1022 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1025 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1027 #if VMG_HAS_PERL(5, 9, 5)
1028 PERL_CONTEXT saved_cx;
1031 unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
1036 /* Don't even bother if we are in global destruction - the wizard is prisoner
1037 * of circular references and we are way beyond user realm */
1041 w = vmg_wizard_mgwiz(mg->mg_ptr);
1043 /* So that it survives the temp cleanup below */
1046 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
1047 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1048 * if you access the sv from the callback the old deleted magics will trigger
1049 * and cause memory misreads. Change 32686 solved it that way : */
1050 SvMAGIC_set(sv, mg);
1058 PUSHs(sv_2mortal(newRV_inc(sv)));
1059 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1061 XPUSHs(vmg_op_info(w->opinfo));
1064 had_err = SvTRUE(ERRSV);
1068 #if VMG_HAS_PERL(5, 9, 5)
1069 /* This context should not be used anymore, but since we croak in places the
1070 * core doesn't even dare to, some pointers to it may remain in the upper call
1071 * stack. Make sure call_sv() doesn't clobber it. */
1072 if (cxstack_ix < cxstack_max)
1073 cxix = cxstack_ix + 1;
1075 cxix = Perl_cxinc(aTHX);
1076 saved_cx = cxstack[cxix];
1079 call_sv(w->cb_free, flags);
1081 #if VMG_HAS_PERL(5, 9, 5)
1082 cxstack[cxix] = saved_cx;
1085 has_err = SvTRUE(ERRSV);
1086 if (IN_PERL_COMPILETIME && !had_err && has_err)
1089 VMG_CB_CALL_SET_RET(0);
1094 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1095 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1098 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1099 * mg->mg_ptr reference count */
1104 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
1105 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
1112 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1115 if (keylen == HEf_SVKEY) {
1118 keysv = newSVpvn(key, keylen);
1121 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1123 if (keylen != HEf_SVKEY) {
1124 SvREFCNT_dec(keysv);
1129 #endif /* MGf_COPY */
1132 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1135 #endif /* MGf_DUP */
1138 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1139 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1140 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1142 #endif /* MGf_LOCAL */
1145 STATIC OP *vmg_pp_resetuvar(pTHX) {
1146 SvRMAGICAL_on(cSVOP_sv);
1150 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1153 SV *key = NULL, *newkey = NULL;
1156 umg = mg_find(sv, PERL_MAGIC_uvar);
1157 /* umg can't be NULL or we wouldn't be there. */
1159 uf = (struct ufuncs *) umg->mg_ptr;
1162 uf[1].uf_val(aTHX_ action, sv);
1164 uf[1].uf_set(aTHX_ action, sv);
1166 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
1167 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1169 switch (mg->mg_type) {
1170 case PERL_MAGIC_ext:
1172 case PERL_MAGIC_tied:
1178 if (mg->mg_private != SIG_WIZ) continue;
1179 w = vmg_wizard_mgwiz(mg->mg_ptr);
1185 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1190 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1192 case HV_FETCH_ISSTORE:
1193 case HV_FETCH_LVALUE:
1194 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1196 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1198 case HV_FETCH_ISEXISTS:
1200 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1204 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1209 if (SvRMAGICAL(sv) && !tied) {
1210 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1211 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1212 * the op_ppaddr of a new fake op injected between the current and the next
1215 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1217 NewOp(1101, svop, 1, SVOP);
1218 svop->op_type = OP_STUB;
1219 svop->op_ppaddr = vmg_pp_resetuvar;
1220 svop->op_next = o->op_next;
1223 o->op_next = (OP *) svop;
1230 #endif /* VMG_UVAR */
1232 /* --- Macros for the XS section ------------------------------------------- */
1234 #define VMG_SET_CB(S, N) \
1236 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1238 #define VMG_SET_SVT_CB(S, N) \
1240 if (SvOK(cb) && SvROK(cb)) { \
1241 t->svt_ ## N = vmg_svt_ ## N; \
1242 w->cb_ ## N = newRV_inc(SvRV(cb)); \
1244 t->svt_ ## N = NULL; \
1245 w->cb_ ## N = NULL; \
1248 /* --- XS ------------------------------------------------------------------ */
1250 MODULE = Variable::Magic PACKAGE = Variable::Magic
1260 MY_CXT.wizards = ptable_new();
1261 MY_CXT.owner = aTHX;
1263 MY_CXT.b__op_stashes[0] = NULL;
1265 MUTEX_INIT(&vmg_op_name_init_mutex);
1268 stash = gv_stashpv(__PACKAGE__, 1);
1269 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1270 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1271 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1272 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1273 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1274 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1275 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1276 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1277 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1278 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1279 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1280 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1281 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1282 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1283 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1284 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1285 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1286 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1287 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1298 U32 had_b__op_stash = 0;
1305 ud.wizards = t = ptable_new();
1306 ud.owner = MY_CXT.owner;
1307 ptable_walk(MY_CXT.wizards, vmg_ptable_clone, &ud);
1309 for (c = 0; c < OPc_MAX; ++c) {
1310 if (MY_CXT.b__op_stashes[c])
1311 had_b__op_stash |= (((U32) 1) << c);
1317 MY_CXT.owner = aTHX;
1318 for (c = 0; c < OPc_MAX; ++c) {
1319 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1320 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1325 #endif /* VMG_THREADSAFE */
1340 #endif /* MGf_COPY */
1343 #endif /* MGf_DUP */
1346 #endif /* MGf_LOCAL */
1349 #endif /* VMG_UVAR */
1350 ) { croak(vmg_wrongargnum); }
1355 VMG_SET_CB(ST(i++), data);
1357 w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1359 vmg_op_info_init(w->opinfo);
1360 VMG_SET_SVT_CB(ST(i++), get);
1361 VMG_SET_SVT_CB(ST(i++), set);
1362 VMG_SET_SVT_CB(ST(i++), len);
1363 VMG_SET_SVT_CB(ST(i++), clear);
1364 VMG_SET_SVT_CB(ST(i++), free);
1366 VMG_SET_SVT_CB(ST(i++), copy);
1367 #endif /* MGf_COPY */
1369 /* VMG_SET_SVT_CB(ST(i++), dup); */
1373 #endif /* MGf_DUP */
1375 VMG_SET_SVT_CB(ST(i++), local);
1376 #endif /* MGf_LOCAL */
1378 VMG_SET_CB(ST(i++), fetch);
1379 VMG_SET_CB(ST(i++), store);
1380 VMG_SET_CB(ST(i++), exists);
1381 VMG_SET_CB(ST(i++), delete);
1383 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1384 w->uvar = SvTRUE(cb) ? 2 : 1;
1387 #endif /* VMG_UVAR */
1388 #if VMG_MULTIPLICITY
1390 #endif /* VMG_MULTIPLICITY */
1393 ptable_store(MY_CXT.wizards, w, w);
1394 #endif /* VMG_THREADSAFE */
1396 RETVAL = newRV_noinc(vmg_wizard_new(w));
1400 SV *cast(SV *sv, SV *wiz, ...)
1401 PROTOTYPE: \[$@%&*]$@
1406 wiz = vmg_wizard_validate(wiz);
1410 av_fill(args, items - 2);
1411 for (i = 2; i < items; ++i) {
1414 if (av_store(args, i - 2, arg) == NULL) croak(vmg_argstorefailed);
1417 ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1424 getdata(SV *sv, SV *wiz)
1425 PROTOTYPE: \[$@%&*]$
1429 wiz = vmg_wizard_validate(wiz);
1430 data = vmg_data_get(SvRV(sv), wiz);
1436 SV *dispell(SV *sv, SV *wiz)
1437 PROTOTYPE: \[$@%&*]$
1439 wiz = vmg_wizard_validate(wiz);
1440 RETVAL = newSVuv(vmg_dispell(SvRV(sv), wiz));