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
58 #if VMG_MULTIPLICITY && !defined(tTHX)
59 # define tTHX PerlInterpreter*
62 #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))
63 # define VMG_THREADSAFE 1
65 # define MY_CXT_CLONE \
67 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
68 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
69 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
72 # define VMG_THREADSAFE 0
74 # define dMY_CXT dNOOP
76 # define MY_CXT vmg_globaldata
78 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
80 # define MY_CXT_INIT NOOP
82 # define MY_CXT_CLONE NOOP
86 # define VMG_LOCK(M) MUTEX_LOCK(M)
87 # define VMG_UNLOCK(M) MUTEX_UNLOCK(M)
90 # define VMG_UNLOCK(M)
95 STATIC SV *vmg_clone(pTHX_ SV *sv, tTHX owner) {
96 #define vmg_clone(P, O) vmg_clone(aTHX_ (P), (O))
99 #if VMG_HAS_PERL(5, 13, 2)
100 CLONE_PARAMS *param = Perl_clone_params_new(owner, aTHX);
102 dupsv = sv_dup(sv, param);
104 Perl_clone_params_del(param);
108 param.stashes = NULL; /* don't need it unless sv is a PVHV */
110 param.proto_perl = owner;
112 dupsv = sv_dup(sv, ¶m);
115 return SvREFCNT_inc(dupsv);
118 #endif /* VMG_THREADSAFE */
120 /* --- Compatibility ------------------------------------------------------- */
123 # define Newx(v, n, c) New(0, v, n, c)
127 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
131 # define SvRV_const(sv) SvRV((SV *) sv)
134 #ifndef SvREFCNT_inc_simple_void
135 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
139 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
142 #ifndef PERL_MAGIC_ext
143 # define PERL_MAGIC_ext '~'
146 #ifndef PERL_MAGIC_tied
147 # define PERL_MAGIC_tied 'P'
154 #ifndef IN_PERL_COMPILETIME
155 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
158 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
159 * enable them on 5.10 */
160 #if VMG_HAS_PERL(5, 10, 0)
166 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
167 * reverted to dev-5.11 as 9cdcb38b */
168 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
169 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
170 # if VMG_HAS_PERL(5, 11, 0)
171 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
173 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
176 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
177 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
180 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
181 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
183 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
184 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
188 /* Applied to dev-5.11 as 34908 */
189 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
190 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
192 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
195 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
196 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
197 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
199 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
202 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
203 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
205 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
208 #if VMG_HAS_PERL(5, 13, 2)
209 # define VMG_COMPAT_GLOB_GET 1
211 # define VMG_COMPAT_GLOB_GET 0
214 /* ... Bug-free mg_magical ................................................. */
216 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
218 #if VMG_HAS_PERL(5, 11, 3)
220 #define vmg_mg_magical(S) mg_magical(S)
224 STATIC void vmg_mg_magical(SV *sv) {
228 if ((mg = SvMAGIC(sv))) {
230 const MGVTBL* const vtbl = mg->mg_virtual;
232 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
239 } while ((mg = mg->mg_moremagic));
240 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
247 /* ... Safe version of call_sv() ........................................... */
249 #define VMG_SAVE_LAST_CX (!VMG_HAS_PERL(5, 8, 4) || VMG_HAS_PERL(5, 9, 5))
251 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, I32 destructor) {
252 #define vmg_call_sv(S, F, D) vmg_call_sv(aTHX_ (S), (F), (D))
253 I32 ret, cxix = 0, in_eval = 0;
255 PERL_CONTEXT saved_cx;
264 if (cxstack_ix < cxstack_max) {
265 cxix = cxstack_ix + 1;
266 if (destructor && CxTYPE(cxstack + cxix) == CXt_EVAL)
271 /* The last popped context will be reused by call_sv(), but our callers may
272 * still need its previous value. Back it up so that it isn't clobbered. */
273 saved_cx = cxstack[cxix];
276 ret = call_sv(sv, flags | G_EVAL);
279 cxstack[cxix] = saved_cx;
284 sv_setsv(old_err, ERRSV);
288 if (IN_PERL_COMPILETIME) {
291 sv_catsv(PL_errors, ERRSV);
293 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
296 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
298 ++PL_parser->error_count;
299 #elif defined(PL_error_count)
316 /* --- Stolen chunk of B --------------------------------------------------- */
334 STATIC const char *const vmg_opclassnames[] = {
349 STATIC opclass vmg_opclass(const OP *o) {
356 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
358 if (o->op_type == OP_SASSIGN)
359 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
361 if (o->op_type == OP_AELEMFAST) {
362 #if PERL_VERSION <= 14
363 if (o->op_flags & OPf_SPECIAL)
375 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
379 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
396 case OA_PVOP_OR_SVOP:
397 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
402 case OA_BASEOP_OR_UNOP:
403 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
405 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
407 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
409 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
412 if (o->op_flags & OPf_STACKED)
414 else if (o->op_flags & OPf_SPECIAL)
423 /* --- Error messages ------------------------------------------------------ */
425 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
426 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
427 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
429 /* --- Signatures ---------------------------------------------------------- */
431 #define SIG_WZO ((U16) (0x3891))
432 #define SIG_WIZ ((U16) (0x3892))
434 /* --- <vmg_vtable> structure ---------------------------------------------- */
443 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
444 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
447 t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
449 t->vtbl = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
455 #define vmg_vtable_vtbl(T) (T)->vtbl
458 STATIC perl_mutex vmg_vtable_refcount_mutex;
461 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
462 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
463 VMG_LOCK(&vmg_vtable_refcount_mutex);
465 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
470 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
471 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
474 VMG_LOCK(&vmg_vtable_refcount_mutex);
475 refcount = --t->refcount;
476 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
479 PerlMemShared_free(t->vtbl);
480 PerlMemShared_free(t);
484 #else /* VMG_THREADSAFE */
486 typedef MGVTBL vmg_vtable;
488 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
489 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
492 Newx(t, 1, vmg_vtable);
497 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
499 #define vmg_vtable_free(T) Safefree(T)
501 #endif /* !VMG_THREADSAFE */
503 /* --- MGWIZ structure ----------------------------------------------------- */
512 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
517 #endif /* MGf_LOCAL */
519 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
520 #endif /* VMG_UVAR */
524 #endif /* VMG_MULTIPLICITY */
527 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
529 STATIC MGWIZ *vmg_mgwiz_alloc(pTHX_ UV opinfo) {
530 #define vmg_mgwiz_alloc(O) vmg_mgwiz_alloc(aTHX_ (O))
537 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
539 vmg_op_info_init(aTHX_ w->opinfo);
541 w->vtable = vmg_vtable_alloc();
546 STATIC void vmg_mgwiz_free(pTHX_ MGWIZ *w) {
547 #define vmg_mgwiz_free(W) vmg_mgwiz_free(aTHX_ (W))
551 /* We reach this point in dirty state when ptable_free() is called from the
552 * atexit cleanup callback, and that the global table still holds a live
553 * wizard. This happens before all the SV bodies are freed, so all the wizard
554 * callbacks are still alive (as they are referenced by the undead wizard).
555 * Hence it is safe to decrement their refcount. Later on, the wizard free
556 * callback itself will trigger when the wizard body is reaped, but it will
557 * be skipped as it guards against dirty state - which is good since nothing
558 * has to be done anymore at that point. */
560 SvREFCNT_dec(w->cb_data);
561 SvREFCNT_dec(w->cb_get);
562 SvREFCNT_dec(w->cb_set);
563 SvREFCNT_dec(w->cb_len);
564 SvREFCNT_dec(w->cb_clear);
565 SvREFCNT_dec(w->cb_free);
566 SvREFCNT_dec(w->cb_copy);
568 SvREFCNT_dec(w->cb_dup);
571 SvREFCNT_dec(w->cb_local);
572 #endif /* MGf_LOCAL */
574 SvREFCNT_dec(w->cb_fetch);
575 SvREFCNT_dec(w->cb_store);
576 SvREFCNT_dec(w->cb_exists);
577 SvREFCNT_dec(w->cb_delete);
578 #endif /* VMG_UVAR */
580 vmg_vtable_free(w->vtable);
588 #define VMG_CLONE_CB(N) \
589 z->cb_ ## N = (w->cb_ ## N) ? vmg_clone(w->cb_ ## N, w->owner) \
592 STATIC MGWIZ *vmg_mgwiz_clone(pTHX_ const MGWIZ *w) {
593 #define vmg_mgwiz_clone(W) vmg_mgwiz_clone(aTHX_ (W))
601 z->vtable = vmg_vtable_dup(w->vtable);
603 z->opinfo = w->opinfo;
615 #endif /* MGf_LOCAL */
619 VMG_CLONE_CB(exists);
620 VMG_CLONE_CB(delete);
621 #endif /* VMG_UVAR */
628 #endif /* VMG_THREADSAFE */
630 /* --- Context-safe global data -------------------------------------------- */
634 #define PTABLE_NAME ptable
635 #define PTABLE_VAL_FREE(V) vmg_mgwiz_free(VOID2(MGWIZ *, (V)))
644 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
645 #define ptable_clear(T) ptable_clear(aTHX_ (T))
646 #define ptable_free(T) ptable_free(aTHX_ (T))
648 #endif /* VMG_THREADSAFE */
650 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
657 HV *b__op_stashes[OPc_MAX];
664 STATIC void vmg_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
665 my_cxt_t *ud = VOID2(my_cxt_t *, ud_);
668 if (ud->owner == aTHX)
671 w = vmg_mgwiz_clone(VOID2(MGWIZ *, ent->val));
673 ptable_store(ud->wizards, ent->key, w);
676 #endif /* VMG_THREADSAFE */
678 /* --- Wizard objects ------------------------------------------------------ */
680 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg);
682 STATIC MGVTBL vmg_wizard_vtbl = {
687 vmg_wizard_free, /* free */
692 #endif /* MGf_LOCAL */
695 /* ... Wizard constructor .................................................. */
697 STATIC SV *vmg_wizard_new(pTHX_ const MGWIZ *w) {
698 #define vmg_wizard_new(W) vmg_wizard_new(aTHX_ (W))
699 SV *wiz = newSVuv(PTR2IV(w));
702 MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
703 mg->mg_private = SIG_WZO;
710 STATIC const SV *vmg_wizard_validate(pTHX_ const SV *wiz) {
711 #define vmg_wizard_validate(W) vmg_wizard_validate(aTHX_ (W))
713 wiz = SvRV_const(wiz);
718 croak(vmg_invalid_wiz);
723 #define vmg_wizard_id(W) SvIVX((const SV *) (W))
724 #define vmg_wizard_main_mgwiz(W) INT2PTR(const MGWIZ *, vmg_wizard_id(W))
726 /* ... Wizard destructor ................................................... */
728 STATIC int vmg_wizard_free(pTHX_ SV *sv, MAGIC *mg) {
731 if (PL_dirty) /* During global destruction, the context is already freed */
734 w = (MGWIZ *) vmg_wizard_main_mgwiz(sv);
739 ptable_store(MY_CXT.wizards, w, NULL);
741 #else /* VMG_THREADSAFE */
743 #endif /* !VMG_THREADSAFE */
750 STATIC const MGWIZ *vmg_wizard_mgwiz(pTHX_ const SV *wiz) {
751 #define vmg_wizard_mgwiz(W) vmg_wizard_mgwiz(aTHX_ ((const SV *) (W)))
754 w = vmg_wizard_main_mgwiz(wiz);
755 if (w->owner == aTHX)
760 return VOID2(const MGWIZ *, ptable_fetch(MY_CXT.wizards, w));
764 #else /* VMG_THREADSAFE */
766 #define vmg_wizard_mgwiz(W) vmg_wizard_main_mgwiz(W)
768 #endif /* !VMG_THREADSAFE */
770 /* --- User-level functions implementation --------------------------------- */
772 STATIC const MAGIC *vmg_find(const SV *sv, const SV *wiz) {
773 const MAGIC *mg, *moremagic;
776 if (SvTYPE(sv) < SVt_PVMG)
779 wid = vmg_wizard_id(wiz);
780 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
781 moremagic = mg->mg_moremagic;
782 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
783 IV zid = vmg_wizard_id(mg->mg_ptr);
792 /* ... Construct private data .............................................. */
794 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
795 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
805 EXTEND(SP, items + 1);
806 PUSHs(sv_2mortal(newRV_inc(sv)));
807 for (i = 0; i < items; ++i)
811 vmg_call_sv(ctor, G_SCALAR, 0);
815 #if VMG_HAS_PERL(5, 8, 3)
816 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
818 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
828 STATIC SV *vmg_data_get(pTHX_ SV *sv, const SV *wiz) {
829 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
830 const MAGIC *mg = vmg_find(sv, wiz);
831 return mg ? mg->mg_obj : NULL;
834 /* ... Magic cast/dispell .................................................. */
837 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
839 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
841 prevmagic->mg_moremagic = moremagic;
843 SvMAGIC_set(sv, moremagic);
845 mg->mg_moremagic = NULL;
846 Safefree(mg->mg_ptr);
849 #endif /* VMG_UVAR */
851 STATIC UV vmg_cast(pTHX_ SV *sv, const SV *wiz, SV **args, I32 items) {
852 #define vmg_cast(S, W, A, I) vmg_cast(aTHX_ (S), (W), (A), (I))
858 if (vmg_find(sv, wiz))
861 w = vmg_wizard_mgwiz(wiz);
862 oldgmg = SvGMAGICAL(sv);
864 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
865 /* sv_magicext() calls mg_magical and increments data's refcount */
866 mg = sv_magicext(sv, data, PERL_MAGIC_ext, vmg_vtable_vtbl(w->vtable),
867 (const char *) wiz, HEf_SVKEY);
869 mg->mg_private = SIG_WIZ;
871 mg->mg_flags |= MGf_COPY;
874 mg->mg_flags |= MGf_DUP;
878 mg->mg_flags |= MGf_LOCAL;
879 #endif /* MGf_LOCAL */
881 if (SvTYPE(sv) < SVt_PVHV)
884 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
885 * magic is actually never called for them. If the GMAGICAL flag was off before
886 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
887 * now on, then this wizard has get magic. Hence we can work around the
888 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
889 * has uvar callbacks, it will be turned back on later. */
890 if (!oldgmg && SvGMAGICAL(sv))
895 MAGIC *prevmagic, *moremagic = NULL;
898 uf[0].uf_val = vmg_svt_val;
905 /* One uvar magic in the chain is enough. */
906 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
907 moremagic = mg->mg_moremagic;
908 if (mg->mg_type == PERL_MAGIC_uvar)
912 if (mg) { /* Found another uvar magic. */
913 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
914 if (olduf->uf_val == vmg_svt_val) {
915 /* It's our uvar magic, nothing to do. oldgmg was true. */
918 /* It's another uvar magic, backup it and replace it by ours. */
920 vmg_uvar_del(sv, prevmagic, mg, moremagic);
924 sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &uf, sizeof(uf));
926 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
927 * handled by our uvar callback. */
929 #endif /* VMG_UVAR */
935 STATIC UV vmg_dispell(pTHX_ SV *sv, const SV *wiz) {
936 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
939 #endif /* VMG_UVAR */
940 MAGIC *mg, *prevmagic, *moremagic = NULL;
941 IV wid = vmg_wizard_id(wiz);
943 if (SvTYPE(sv) < SVt_PVMG)
946 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
947 moremagic = mg->mg_moremagic;
948 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
950 const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
951 #endif /* VMG_UVAR */
952 IV zid = vmg_wizard_id(mg->mg_ptr);
955 /* If the current has no uvar, short-circuit uvar deletion. */
956 uvars = z->uvar ? (uvars + 1) : 0;
957 #endif /* VMG_UVAR */
960 } else if (z->uvar) {
962 /* We can't break here since we need to find the ext magic to delete. */
963 #endif /* VMG_UVAR */
971 prevmagic->mg_moremagic = moremagic;
973 SvMAGIC_set(sv, moremagic);
975 mg->mg_moremagic = NULL;
977 /* Destroy private data */
978 if (mg->mg_obj != sv)
979 SvREFCNT_dec(mg->mg_obj);
980 /* Unreference the wizard */
981 SvREFCNT_dec((SV *) mg->mg_ptr);
985 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
986 /* mg was the first ext magic in the chain that had uvar */
988 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
989 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
990 const MGWIZ *z = vmg_wizard_mgwiz(mg->mg_ptr);
1000 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1001 moremagic = mg->mg_moremagic;
1002 if (mg->mg_type == PERL_MAGIC_uvar)
1006 uf = (struct ufuncs *) mg->mg_ptr;
1007 /* assert(uf->uf_val == vmg_svt_val); */
1008 if (uf[1].uf_val || uf[1].uf_set) {
1009 /* Revert the original uvar magic. */
1011 Renew(uf, 1, struct ufuncs);
1012 mg->mg_ptr = (char *) uf;
1013 mg->mg_len = sizeof(struct ufuncs);
1015 /* Remove the uvar magic. */
1016 vmg_uvar_del(sv, prevmagic, mg, moremagic);
1020 #endif /* VMG_UVAR */
1027 /* ... OP info ............................................................. */
1029 #define VMG_OP_INFO_NAME 1
1030 #define VMG_OP_INFO_OBJECT 2
1033 STATIC perl_mutex vmg_op_name_init_mutex;
1036 STATIC U32 vmg_op_name_init = 0;
1037 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
1039 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1040 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1042 case VMG_OP_INFO_NAME:
1043 VMG_LOCK(&vmg_op_name_init_mutex);
1044 if (!vmg_op_name_init) {
1046 for (t = 0; t < OP_max; ++t)
1047 vmg_op_name_len[t] = strlen(PL_op_name[t]);
1048 vmg_op_name_init = 1;
1050 VMG_UNLOCK(&vmg_op_name_init_mutex);
1052 case VMG_OP_INFO_OBJECT: {
1054 if (!MY_CXT.b__op_stashes[0]) {
1057 for (c = OPc_NULL; c < OPc_MAX; ++c)
1058 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1067 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1068 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1070 return &PL_sv_undef;
1073 case VMG_OP_INFO_NAME: {
1074 OPCODE t = PL_op->op_type;
1075 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1077 case VMG_OP_INFO_OBJECT: {
1079 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1080 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1086 return &PL_sv_undef;
1089 /* ... svt callbacks ....................................................... */
1091 #define VMG_CB_CALL_ARGS_MASK 15
1092 #define VMG_CB_CALL_ARGS_SHIFT 4
1093 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1095 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1098 unsigned int i, args, opinfo;
1103 args = flags & VMG_CB_CALL_ARGS_MASK;
1104 flags >>= VMG_CB_CALL_ARGS_SHIFT;
1105 opinfo = flags & VMG_CB_CALL_OPINFO;
1111 EXTEND(SP, args + 1);
1112 PUSHs(sv_2mortal(newRV_inc(sv)));
1114 for (i = 0; i < args; ++i) {
1115 SV *sva = va_arg(ap, SV *);
1116 PUSHs(sva ? sva : &PL_sv_undef);
1120 XPUSHs(vmg_op_info(opinfo));
1123 vmg_call_sv(cb, G_SCALAR, 0);
1128 ret = (int) SvIV(svr);
1137 #define VMG_CB_FLAGS(OI, A) \
1138 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1140 #define vmg_cb_call1(I, OI, S, A1) \
1141 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1142 #define vmg_cb_call2(I, OI, S, A1, A2) \
1143 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1144 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1145 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1147 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1148 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1149 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1152 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1153 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1154 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1157 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1158 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1159 unsigned int opinfo = w->opinfo;
1162 svtype t = SvTYPE(sv);
1171 PUSHs(sv_2mortal(newRV_inc(sv)));
1172 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1175 #if VMG_HAS_PERL(5, 9, 3)
1176 const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, l)));
1178 U8 *s = SvPV(sv, l);
1181 len = utf8_length(s, s + l);
1185 } else if (t == SVt_PVAV) {
1186 len = av_len((AV *) sv) + 1;
1190 PUSHs(&PL_sv_undef);
1193 XPUSHs(vmg_op_info(opinfo));
1196 vmg_call_sv(w->cb_len, G_SCALAR, 0);
1200 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1211 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1212 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1213 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1216 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1223 /* Don't even bother if we are in global destruction - the wizard is prisoner
1224 * of circular references and we are way beyond user realm */
1228 w = vmg_wizard_mgwiz(mg->mg_ptr);
1230 /* So that it survives the temp cleanup below */
1231 SvREFCNT_inc_simple_void(sv);
1233 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1234 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1235 * if you access the sv from the callback the old deleted magics will trigger
1236 * and cause memory misreads. Change 32686 solved it that way : */
1237 SvMAGIC_set(sv, mg);
1245 PUSHs(sv_2mortal(newRV_inc(sv)));
1246 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1248 XPUSHs(vmg_op_info(w->opinfo));
1251 vmg_call_sv(w->cb_free, G_SCALAR, 1);
1256 ret = (int) SvIV(svr);
1262 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1263 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1266 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1267 * mg->mg_ptr reference count */
1271 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
1272 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1279 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1282 if (keylen == HEf_SVKEY) {
1285 keysv = newSVpvn(key, keylen);
1288 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1290 if (keylen != HEf_SVKEY) {
1291 SvREFCNT_dec(keysv);
1298 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1304 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1305 const MGWIZ *w = vmg_wizard_mgwiz(mg->mg_ptr);
1306 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1308 #endif /* MGf_LOCAL */
1311 STATIC OP *vmg_pp_resetuvar(pTHX) {
1312 SvRMAGICAL_on(cSVOP_sv);
1316 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1319 SV *key = NULL, *newkey = NULL;
1322 umg = mg_find(sv, PERL_MAGIC_uvar);
1323 /* umg can't be NULL or we wouldn't be there. */
1325 uf = (struct ufuncs *) umg->mg_ptr;
1328 uf[1].uf_val(aTHX_ action, sv);
1330 uf[1].uf_set(aTHX_ action, sv);
1332 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
1333 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1335 switch (mg->mg_type) {
1336 case PERL_MAGIC_ext:
1338 case PERL_MAGIC_tied:
1344 if (mg->mg_private != SIG_WIZ) continue;
1345 w = vmg_wizard_mgwiz(mg->mg_ptr);
1351 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1356 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1358 case HV_FETCH_ISSTORE:
1359 case HV_FETCH_LVALUE:
1360 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1362 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1364 case HV_FETCH_ISEXISTS:
1366 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1370 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1375 if (SvRMAGICAL(sv) && !tied) {
1376 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1377 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1378 * the op_ppaddr of a new fake op injected between the current and the next
1381 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1383 NewOp(1101, svop, 1, SVOP);
1384 svop->op_type = OP_STUB;
1385 svop->op_ppaddr = vmg_pp_resetuvar;
1386 svop->op_next = o->op_next;
1389 o->op_next = (OP *) svop;
1396 #endif /* VMG_UVAR */
1398 /* --- Macros for the XS section ------------------------------------------- */
1400 #define VMG_SET_CB(S, N) \
1402 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? SvREFCNT_inc(SvRV(cb)) : NULL;
1404 #define VMG_SET_SVT_CB(S, N) \
1406 if (SvOK(cb) && SvROK(cb)) { \
1407 t->svt_ ## N = vmg_svt_ ## N; \
1408 w->cb_ ## N = SvREFCNT_inc(SvRV(cb)); \
1410 t->svt_ ## N = NULL; \
1411 w->cb_ ## N = NULL; \
1416 STATIC void vmg_cleanup(pTHX_ void *ud) {
1419 ptable_free(MY_CXT.wizards);
1420 MY_CXT.wizards = NULL;
1423 #endif /* VMG_THREADSAFE */
1425 /* --- XS ------------------------------------------------------------------ */
1427 MODULE = Variable::Magic PACKAGE = Variable::Magic
1437 MY_CXT.wizards = ptable_new();
1438 MY_CXT.owner = aTHX;
1440 MY_CXT.b__op_stashes[0] = NULL;
1442 MUTEX_INIT(&vmg_vtable_refcount_mutex);
1443 MUTEX_INIT(&vmg_op_name_init_mutex);
1444 call_atexit(vmg_cleanup, NULL);
1447 stash = gv_stashpv(__PACKAGE__, 1);
1448 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1449 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1450 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1451 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1452 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1453 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1454 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1455 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1456 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1457 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1458 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1459 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1460 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1461 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1462 newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1463 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1464 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1465 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1466 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1467 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1477 U32 had_b__op_stash = 0;
1484 ud.wizards = t = ptable_new();
1485 ud.owner = MY_CXT.owner;
1486 ptable_walk(MY_CXT.wizards, vmg_ptable_clone, &ud);
1488 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1489 if (MY_CXT.b__op_stashes[c])
1490 had_b__op_stash |= (((U32) 1) << c);
1496 MY_CXT.owner = aTHX;
1497 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1498 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1499 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1504 #endif /* VMG_THREADSAFE */
1512 SV *cb, *op_info, *copy_key;
1519 #endif /* MGf_LOCAL */
1522 #endif /* VMG_UVAR */
1523 ) { croak(vmg_wrongargnum); }
1526 w = vmg_mgwiz_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1527 t = vmg_vtable_vtbl(w->vtable);
1529 VMG_SET_CB(ST(i++), data);
1531 VMG_SET_SVT_CB(ST(i++), get);
1532 VMG_SET_SVT_CB(ST(i++), set);
1533 VMG_SET_SVT_CB(ST(i++), len);
1534 VMG_SET_SVT_CB(ST(i++), clear);
1535 VMG_SET_SVT_CB(ST(i++), free);
1536 VMG_SET_SVT_CB(ST(i++), copy);
1537 /* VMG_SET_SVT_CB(ST(i++), dup); */
1542 VMG_SET_SVT_CB(ST(i++), local);
1543 #endif /* MGf_LOCAL */
1545 VMG_SET_CB(ST(i++), fetch);
1546 VMG_SET_CB(ST(i++), store);
1547 VMG_SET_CB(ST(i++), exists);
1548 VMG_SET_CB(ST(i++), delete);
1551 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1552 w->uvar = SvTRUE(copy_key) ? 2 : 1;
1553 #endif /* VMG_UVAR */
1554 #if VMG_MULTIPLICITY
1556 #endif /* VMG_MULTIPLICITY */
1558 ptable_store(MY_CXT.wizards, w, w);
1559 #endif /* VMG_THREADSAFE */
1561 RETVAL = newRV_noinc(vmg_wizard_new(w));
1565 SV *cast(SV *sv, SV *wiz, ...)
1566 PROTOTYPE: \[$@%&*]$@
1575 RETVAL = newSVuv(vmg_cast(SvRV(sv), vmg_wizard_validate(wiz), args, i));
1580 getdata(SV *sv, SV *wiz)
1581 PROTOTYPE: \[$@%&*]$
1585 data = vmg_data_get(SvRV(sv), vmg_wizard_validate(wiz));
1591 SV *dispell(SV *sv, SV *wiz)
1592 PROTOTYPE: \[$@%&*]$
1594 RETVAL = newSVuv(vmg_dispell(SvRV(sv), vmg_wizard_validate(wiz)));