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 SvRV_const(sv) SvRV((SV *) sv)
107 #ifndef SvREFCNT_inc_simple_void
108 # define SvREFCNT_inc_simple_void(sv) SvREFCNT_inc(sv)
112 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
115 #ifndef PERL_MAGIC_ext
116 # define PERL_MAGIC_ext '~'
119 #ifndef PERL_MAGIC_tied
120 # define PERL_MAGIC_tied 'P'
135 #ifndef IN_PERL_COMPILETIME
136 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
139 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
140 # ifndef PL_error_count
141 # define PL_error_count PL_parser->error_count
144 # ifndef PL_error_count
145 # define PL_error_count PL_Ierror_count
149 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but only
150 * enable it on 5.10 */
151 #if VMG_HAS_PERL(5, 10, 0)
157 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
158 * reverted to dev-5.11 as 9cdcb38b */
159 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
160 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
161 /* This branch should only apply for perls before the official 5.11.0 release.
162 * Makefile.PL takes care of the higher ones. */
163 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
165 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
166 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
169 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
170 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
172 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
173 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
177 /* Applied to dev-5.11 as 34908 */
178 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
179 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
181 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
184 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
185 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
186 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
188 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
191 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
192 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
194 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
199 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
200 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
201 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
203 sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
204 /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
205 if ((mg = SvMAGIC(sv))) {
208 const MGVTBL* const vtbl = mg->mg_virtual;
210 if (vtbl->svt_clear) {
215 } while ((mg = mg->mg_moremagic));
219 #endif /* VMG_UVAR */
221 /* --- Stolen chunk of B --------------------------------------------------- */
239 STATIC const char *const vmg_opclassnames[] = {
254 STATIC opclass vmg_opclass(const OP *o) {
261 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
263 if (o->op_type == OP_SASSIGN)
264 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
266 if (o->op_type == OP_AELEMFAST) {
267 if (o->op_flags & OPf_SPECIAL)
278 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
282 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
299 case OA_PVOP_OR_SVOP:
300 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
305 case OA_BASEOP_OR_UNOP:
306 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
308 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
310 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
312 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
315 if (o->op_flags & OPf_STACKED)
317 else if (o->op_flags & OPf_SPECIAL)
326 /* --- Error messages ------------------------------------------------------ */
328 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
329 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
330 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
332 /* --- Signatures ---------------------------------------------------------- */
334 #define SIG_WZO ((U16) (0x3891))
335 #define SIG_WIZ ((U16) (0x3892))
337 /* --- MGWIZ structure ----------------------------------------------------- */
346 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
349 #endif /* MGf_COPY */
355 #endif /* MGf_LOCAL */
357 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
358 #endif /* VMG_UVAR */
362 #endif /* VMG_MULTIPLICITY */
365 STATIC void vmg_mgwiz_free(pTHX_ MGWIZ *w) {
366 #define vmg_mgwiz_free(W) vmg_mgwiz_free(aTHX_ (W))
370 if (w->cb_data) SvREFCNT_dec(w->cb_data);
371 if (w->cb_get) SvREFCNT_dec(w->cb_get);
372 if (w->cb_set) SvREFCNT_dec(w->cb_set);
373 if (w->cb_len) SvREFCNT_dec(w->cb_len);
374 if (w->cb_clear) SvREFCNT_dec(w->cb_clear);
375 if (w->cb_free) SvREFCNT_dec(w->cb_free);
377 if (w->cb_copy) SvREFCNT_dec(w->cb_copy);
378 #endif /* MGf_COPY */
380 if (w->cb_dup) SvREFCNT_dec(w->cb_dup);
383 if (w->cb_local) SvREFCNT_dec(w->cb_local);
384 #endif /* MGf_LOCAL */
386 if (w->cb_fetch) SvREFCNT_dec(w->cb_fetch);
387 if (w->cb_store) SvREFCNT_dec(w->cb_store);
388 if (w->cb_exists) SvREFCNT_dec(w->cb_exists);
389 if (w->cb_delete) SvREFCNT_dec(w->cb_delete);
390 #endif /* VMG_UVAR */
400 #define VMG_CLONE_CB(N) \
401 z->cb_ ## N = (w->cb_ ## N) ? vmg_clone(w->cb_ ## N, w->owner) \
404 STATIC MGWIZ *vmg_mgwiz_clone(pTHX_ const MGWIZ *w) {
405 #define vmg_mgwiz_clone(W) vmg_mgwiz_clone(aTHX_ (W))
413 Copy(w->vtbl, t, 1, MGVTBL);
419 z->opinfo = w->opinfo;
429 #endif /* MGf_COPY */
435 #endif /* MGf_LOCAL */
439 VMG_CLONE_CB(exists);
440 VMG_CLONE_CB(delete);
441 #endif /* VMG_UVAR */
448 #endif /* VMG_THREADSAFE */
450 /* --- Context-safe global data -------------------------------------------- */
454 #define PTABLE_NAME ptable
455 #define PTABLE_VAL_FREE(V) vmg_mgwiz_free(V)
464 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
465 #define ptable_clear(T) ptable_clear(aTHX_ (T))
466 #define ptable_free(T) ptable_free(aTHX_ (T))
468 #endif /* VMG_THREADSAFE */
470 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
477 HV *b__op_stashes[OPc_MAX];
484 STATIC void vmg_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
488 if (ud->owner == aTHX)
491 w = vmg_mgwiz_clone(ent->val);
493 ptable_store(ud->wizards, ent->key, w);
496 #endif /* VMG_THREADSAFE */
498 /* --- Wizard objects ------------------------------------------------------ */
500 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg);
502 STATIC MGVTBL vmg_wizard_vtbl = {
507 vmg_wizard_free, /* free */
510 #endif /* MGf_COPY */
516 #endif /* MGf_LOCAL */
519 /* ... Wizard constructor .................................................. */
521 STATIC SV *vmg_wizard_new(pTHX_ const MGWIZ *w) {
522 #define vmg_wizard_new(W) vmg_wizard_new(aTHX_ (W))
523 SV *wiz = newSVuv(PTR2IV(w));
526 MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
527 mg->mg_private = SIG_WZO;
534 STATIC const SV *vmg_wizard_validate(pTHX_ const SV *wiz) {
535 #define vmg_wizard_validate(W) vmg_wizard_validate(aTHX_ (W))
537 wiz = SvRV_const(wiz);
542 croak(vmg_invalid_wiz);
547 #define vmg_wizard_id(W) SvIVX((const SV *) (W))
548 #define vmg_wizard_main_mgwiz(W) INT2PTR(const MGWIZ *, vmg_wizard_id(W))
550 /* ... Wizard destructor ................................................... */
552 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg) {
555 if (PL_dirty) /* During global destruction, the context is already freed */
558 w = (MGWIZ *) vmg_wizard_main_mgwiz(sv);
563 ptable_store(MY_CXT.wizards, w, NULL);
565 #else /* VMG_THREADSAFE */
567 #endif /* !VMG_THREADSAFE */
574 STATIC const MGWIZ *vmg_wizard_mgwiz(pTHX_ const SV *wiz) {
575 #define vmg_wizard_mgwiz(W) vmg_wizard_mgwiz(aTHX_ ((const SV *) (W)))
578 w = vmg_wizard_main_mgwiz(wiz);
579 if (w->owner == aTHX)
584 return ptable_fetch(MY_CXT.wizards, w);
588 #else /* VMG_THREADSAFE */
590 #define vmg_wizard_mgwiz(W) vmg_wizard_main_mgwiz(W)
592 #endif /* !VMG_THREADSAFE */
594 /* --- User-level functions implementation --------------------------------- */
596 STATIC const MAGIC *vmg_find(const SV *sv, const SV *wiz) {
597 const MAGIC *mg, *moremagic;
600 if (SvTYPE(sv) < SVt_PVMG)
603 wid = vmg_wizard_id(wiz);
604 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
605 moremagic = mg->mg_moremagic;
606 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
607 IV zid = vmg_wizard_id(mg->mg_ptr);
616 /* ... Construct private data .............................................. */
618 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
619 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
629 EXTEND(SP, items + 1);
630 PUSHs(sv_2mortal(newRV_inc(sv)));
631 for (i = 0; i < items; ++i)
635 call_sv(ctor, G_SCALAR);
639 #if VMG_HAS_PERL(5, 8, 3)
640 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
642 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
652 STATIC SV *vmg_data_get(pTHX_ SV *sv, const SV *wiz) {
653 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
654 const MAGIC *mg = vmg_find(sv, wiz);
655 return mg ? mg->mg_obj : NULL;
658 /* ... Magic cast/dispell .................................................. */
661 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
663 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
665 prevmagic->mg_moremagic = moremagic;
667 SvMAGIC_set(sv, moremagic);
669 mg->mg_moremagic = NULL;
670 Safefree(mg->mg_ptr);
673 #endif /* VMG_UVAR */
675 STATIC UV vmg_cast(pTHX_ SV *sv, const SV *wiz, SV **args, I32 items) {
676 #define vmg_cast(S, W, A, I) vmg_cast(aTHX_ (S), (W), (A), (I))
677 MAGIC *mg, *moremagic = NULL;
682 if (vmg_find(sv, wiz))
685 w = vmg_wizard_mgwiz(wiz);
686 oldgmg = SvGMAGICAL(sv);
688 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
689 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
691 mg->mg_private = SIG_WIZ;
694 mg->mg_flags |= MGf_COPY;
695 #endif /* MGf_COPY */
698 mg->mg_flags |= MGf_DUP;
702 mg->mg_flags |= MGf_LOCAL;
703 #endif /* MGf_LOCAL */
705 if (SvTYPE(sv) < SVt_PVHV)
708 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
709 * magic is actually never called for them. If the GMAGICAL flag was off before
710 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
711 * now on, then this wizard has get magic. Hence we can work around the
712 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
713 * has uvar callbacks, it will be turned back on later. */
714 if (!oldgmg && SvGMAGICAL(sv))
722 uf[0].uf_val = vmg_svt_val;
729 /* One uvar magic in the chain is enough. */
730 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
731 moremagic = mg->mg_moremagic;
732 if (mg->mg_type == PERL_MAGIC_uvar)
736 if (mg) { /* Found another uvar magic. */
737 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
738 if (olduf->uf_val == vmg_svt_val) {
739 /* It's our uvar magic, nothing to do. oldgmg was true. */
742 /* It's another uvar magic, backup it and replace it by ours. */
744 vmg_uvar_del(sv, prevmagic, mg, moremagic);
748 vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
749 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
750 * handled by our uvar callback. */
752 #endif /* VMG_UVAR */
758 STATIC UV vmg_dispell(pTHX_ SV *sv, const SV *wiz) {
759 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
762 #endif /* VMG_UVAR */
763 MAGIC *mg, *prevmagic, *moremagic = NULL;
764 IV wid = vmg_wizard_id(wiz);
766 if (SvTYPE(sv) < SVt_PVMG)
769 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
770 moremagic = mg->mg_moremagic;
771 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
772 const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
773 IV zid = vmg_wizard_id(mg->mg_ptr);
776 /* If the current has no uvar, short-circuit uvar deletion. */
777 uvars = z->uvar ? (uvars + 1) : 0;
778 #endif /* VMG_UVAR */
781 } else if (z->uvar) {
783 /* We can't break here since we need to find the ext magic to delete. */
784 #endif /* VMG_UVAR */
792 prevmagic->mg_moremagic = moremagic;
794 SvMAGIC_set(sv, moremagic);
796 mg->mg_moremagic = NULL;
798 /* Destroy private data */
799 if (mg->mg_obj != sv)
800 SvREFCNT_dec(mg->mg_obj);
801 /* Unreference the wizard */
802 SvREFCNT_dec((SV *) mg->mg_ptr);
806 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
807 /* mg was the first ext magic in the chain that had uvar */
809 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
810 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
811 const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
821 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
822 moremagic = mg->mg_moremagic;
823 if (mg->mg_type == PERL_MAGIC_uvar)
827 uf = (struct ufuncs *) mg->mg_ptr;
828 /* assert(uf->uf_val == vmg_svt_val); */
829 if (uf[1].uf_val || uf[1].uf_set) {
830 /* Revert the original uvar magic. */
832 Renew(uf, 1, struct ufuncs);
833 mg->mg_ptr = (char *) uf;
834 mg->mg_len = sizeof(struct ufuncs);
836 /* Remove the uvar magic. */
837 vmg_uvar_del(sv, prevmagic, mg, moremagic);
841 #endif /* VMG_UVAR */
846 /* ... OP info ............................................................. */
848 #define VMG_OP_INFO_NAME 1
849 #define VMG_OP_INFO_OBJECT 2
852 STATIC perl_mutex vmg_op_name_init_mutex;
855 STATIC U32 vmg_op_name_init = 0;
856 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
858 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
859 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
861 case VMG_OP_INFO_NAME:
863 MUTEX_LOCK(&vmg_op_name_init_mutex);
865 if (!vmg_op_name_init) {
867 for (t = 0; t < OP_max; ++t)
868 vmg_op_name_len[t] = strlen(PL_op_name[t]);
869 vmg_op_name_init = 1;
872 MUTEX_UNLOCK(&vmg_op_name_init_mutex);
875 case VMG_OP_INFO_OBJECT: {
877 if (!MY_CXT.b__op_stashes[0]) {
880 for (c = OPc_NULL; c < OPc_MAX; ++c)
881 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
890 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
891 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
896 case VMG_OP_INFO_NAME: {
897 OPCODE t = PL_op->op_type;
898 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
900 case VMG_OP_INFO_OBJECT: {
902 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
903 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
912 /* ... svt callbacks ....................................................... */
914 #define VMG_CB_CALL_ARGS_MASK 15
915 #define VMG_CB_CALL_ARGS_SHIFT 4
916 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
918 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
921 unsigned int i, args, opinfo;
926 args = flags & VMG_CB_CALL_ARGS_MASK;
927 flags >>= VMG_CB_CALL_ARGS_SHIFT;
928 opinfo = flags & VMG_CB_CALL_OPINFO;
934 EXTEND(SP, args + 1);
935 PUSHs(sv_2mortal(newRV_inc(sv)));
937 for (i = 0; i < args; ++i) {
938 SV *sva = va_arg(ap, SV *);
939 PUSHs(sva ? sva : &PL_sv_undef);
943 XPUSHs(vmg_op_info(opinfo));
946 call_sv(cb, G_SCALAR);
951 ret = (int) SvIV(svr);
960 #define VMG_CB_FLAGS(OI, A) \
961 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
963 #define vmg_cb_call1(I, OI, S, A1) \
964 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
965 #define vmg_cb_call2(I, OI, S, A1, A2) \
966 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
967 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
968 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
970 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
971 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
972 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
975 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
976 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
977 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
980 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
981 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
982 unsigned int opinfo = w->opinfo;
985 svtype t = SvTYPE(sv);
994 PUSHs(sv_2mortal(newRV_inc(sv)));
995 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
998 #if VMG_HAS_PERL(5, 9, 3)
999 const U8 *s = SvPV_const(sv, l);
1001 U8 *s = SvPV(sv, l);
1004 len = utf8_length(s, s + l);
1008 } else if (t == SVt_PVAV) {
1009 len = av_len((AV *) sv) + 1;
1013 PUSHs(&PL_sv_undef);
1016 XPUSHs(vmg_op_info(opinfo));
1019 call_sv(w->cb_len, G_SCALAR);
1023 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1034 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1035 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1036 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1039 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1041 #if VMG_HAS_PERL(5, 9, 5)
1042 PERL_CONTEXT saved_cx;
1045 I32 had_err, has_err, flags = G_SCALAR | G_EVAL;
1051 /* Don't even bother if we are in global destruction - the wizard is prisoner
1052 * of circular references and we are way beyond user realm */
1056 w = vmg_wizard_mgwiz(mg->mg_ptr);
1058 /* So that it survives the temp cleanup below */
1059 SvREFCNT_inc_simple_void(sv);
1061 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
1062 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1063 * if you access the sv from the callback the old deleted magics will trigger
1064 * and cause memory misreads. Change 32686 solved it that way : */
1065 SvMAGIC_set(sv, mg);
1073 PUSHs(sv_2mortal(newRV_inc(sv)));
1074 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1076 XPUSHs(vmg_op_info(w->opinfo));
1079 had_err = SvTRUE(ERRSV);
1083 #if VMG_HAS_PERL(5, 9, 5)
1084 /* This context should not be used anymore, but since we croak in places the
1085 * core doesn't even dare to, some pointers to it may remain in the upper call
1086 * stack. Make sure call_sv() doesn't clobber it. */
1087 if (cxstack_ix < cxstack_max)
1088 cxix = cxstack_ix + 1;
1090 cxix = Perl_cxinc(aTHX);
1091 saved_cx = cxstack[cxix];
1094 call_sv(w->cb_free, flags);
1096 #if VMG_HAS_PERL(5, 9, 5)
1097 cxstack[cxix] = saved_cx;
1100 has_err = SvTRUE(ERRSV);
1101 if (IN_PERL_COMPILETIME && !had_err && has_err) {
1103 sv_catsv(PL_errors, ERRSV);
1105 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
1115 ret = (int) SvIV(svr);
1121 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1122 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1125 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1126 * mg->mg_ptr reference count */
1131 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
1132 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
1139 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1142 if (keylen == HEf_SVKEY) {
1145 keysv = newSVpvn(key, keylen);
1148 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1150 if (keylen != HEf_SVKEY) {
1151 SvREFCNT_dec(keysv);
1156 #endif /* MGf_COPY */
1159 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1162 #endif /* MGf_DUP */
1165 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1166 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1167 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1169 #endif /* MGf_LOCAL */
1172 STATIC OP *vmg_pp_resetuvar(pTHX) {
1173 SvRMAGICAL_on(cSVOP_sv);
1177 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1180 SV *key = NULL, *newkey = NULL;
1183 umg = mg_find(sv, PERL_MAGIC_uvar);
1184 /* umg can't be NULL or we wouldn't be there. */
1186 uf = (struct ufuncs *) umg->mg_ptr;
1189 uf[1].uf_val(aTHX_ action, sv);
1191 uf[1].uf_set(aTHX_ action, sv);
1193 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
1194 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1196 switch (mg->mg_type) {
1197 case PERL_MAGIC_ext:
1199 case PERL_MAGIC_tied:
1205 if (mg->mg_private != SIG_WIZ) continue;
1206 w = vmg_wizard_mgwiz(mg->mg_ptr);
1212 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1217 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1219 case HV_FETCH_ISSTORE:
1220 case HV_FETCH_LVALUE:
1221 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1223 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1225 case HV_FETCH_ISEXISTS:
1227 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1231 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1236 if (SvRMAGICAL(sv) && !tied) {
1237 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1238 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1239 * the op_ppaddr of a new fake op injected between the current and the next
1242 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1244 NewOp(1101, svop, 1, SVOP);
1245 svop->op_type = OP_STUB;
1246 svop->op_ppaddr = vmg_pp_resetuvar;
1247 svop->op_next = o->op_next;
1250 o->op_next = (OP *) svop;
1257 #endif /* VMG_UVAR */
1259 /* --- Macros for the XS section ------------------------------------------- */
1261 #define VMG_SET_CB(S, N) \
1263 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? SvREFCNT_inc(SvRV(cb)) : NULL;
1265 #define VMG_SET_SVT_CB(S, N) \
1267 if (SvOK(cb) && SvROK(cb)) { \
1268 t->svt_ ## N = vmg_svt_ ## N; \
1269 w->cb_ ## N = SvREFCNT_inc(SvRV(cb)); \
1271 t->svt_ ## N = NULL; \
1272 w->cb_ ## N = NULL; \
1277 STATIC void vmg_cleanup(pTHX_ void *ud) {
1280 ptable_free(MY_CXT.wizards);
1281 MY_CXT.wizards = NULL;
1284 #endif /* VMG_THREADSAFE */
1286 /* --- XS ------------------------------------------------------------------ */
1288 MODULE = Variable::Magic PACKAGE = Variable::Magic
1298 MY_CXT.wizards = ptable_new();
1299 MY_CXT.owner = aTHX;
1301 MY_CXT.b__op_stashes[0] = NULL;
1303 MUTEX_INIT(&vmg_op_name_init_mutex);
1304 call_atexit(vmg_cleanup, NULL);
1307 stash = gv_stashpv(__PACKAGE__, 1);
1308 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1309 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1310 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1311 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1312 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1313 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1314 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1315 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1316 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1317 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1318 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1319 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1320 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1321 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1322 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1323 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1324 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1325 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1326 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1336 U32 had_b__op_stash = 0;
1343 ud.wizards = t = ptable_new();
1344 ud.owner = MY_CXT.owner;
1345 ptable_walk(MY_CXT.wizards, vmg_ptable_clone, &ud);
1347 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1348 if (MY_CXT.b__op_stashes[c])
1349 had_b__op_stash |= (((U32) 1) << c);
1355 MY_CXT.owner = aTHX;
1356 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1357 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1358 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1363 #endif /* VMG_THREADSAFE */
1379 #endif /* MGf_COPY */
1382 #endif /* MGf_DUP */
1385 #endif /* MGf_LOCAL */
1388 #endif /* VMG_UVAR */
1389 ) { croak(vmg_wrongargnum); }
1394 VMG_SET_CB(ST(i++), data);
1397 opinfo = SvOK(cb) ? SvUV(cb) : 0;
1398 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
1400 vmg_op_info_init(w->opinfo);
1402 VMG_SET_SVT_CB(ST(i++), get);
1403 VMG_SET_SVT_CB(ST(i++), set);
1404 VMG_SET_SVT_CB(ST(i++), len);
1405 VMG_SET_SVT_CB(ST(i++), clear);
1406 VMG_SET_SVT_CB(ST(i++), free);
1408 VMG_SET_SVT_CB(ST(i++), copy);
1409 #endif /* MGf_COPY */
1411 /* VMG_SET_SVT_CB(ST(i++), dup); */
1415 #endif /* MGf_DUP */
1417 VMG_SET_SVT_CB(ST(i++), local);
1418 #endif /* MGf_LOCAL */
1420 VMG_SET_CB(ST(i++), fetch);
1421 VMG_SET_CB(ST(i++), store);
1422 VMG_SET_CB(ST(i++), exists);
1423 VMG_SET_CB(ST(i++), delete);
1425 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1426 w->uvar = SvTRUE(cb) ? 2 : 1;
1429 #endif /* VMG_UVAR */
1430 #if VMG_MULTIPLICITY
1432 #endif /* VMG_MULTIPLICITY */
1435 ptable_store(MY_CXT.wizards, w, w);
1436 #endif /* VMG_THREADSAFE */
1438 RETVAL = newRV_noinc(vmg_wizard_new(w));
1442 SV *cast(SV *sv, SV *wiz, ...)
1443 PROTOTYPE: \[$@%&*]$@
1452 RETVAL = newSVuv(vmg_cast(SvRV(sv), vmg_wizard_validate(wiz), args, i));
1457 getdata(SV *sv, SV *wiz)
1458 PROTOTYPE: \[$@%&*]$
1462 data = vmg_data_get(SvRV(sv), vmg_wizard_validate(wiz));
1468 SV *dispell(SV *sv, SV *wiz)
1469 PROTOTYPE: \[$@%&*]$
1471 RETVAL = newSVuv(vmg_dispell(SvRV(sv), vmg_wizard_validate(wiz)));