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 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
137 * reverted to dev-5.11 as 9cdcb38b */
138 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
139 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
140 # if VMG_HAS_PERL(5, 11, 0)
141 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
143 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
146 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
147 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
150 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
151 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
153 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
154 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
158 /* Applied to dev-5.11 as 34908 */
159 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908) || VMG_HAS_PERL(5, 12, 0)
160 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
162 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
165 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
166 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
167 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
169 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
172 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969) || VMG_HAS_PERL(5, 12, 0)
173 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
175 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
178 #if VMG_HAS_PERL(5, 13, 2)
179 # define VMG_COMPAT_GLOB_GET 1
181 # define VMG_COMPAT_GLOB_GET 0
184 /* ... Bug-free mg_magical ................................................. */
186 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
188 #if VMG_HAS_PERL(5, 11, 3)
190 #define vmg_mg_magical(S) mg_magical(S)
194 STATIC void vmg_mg_magical(SV *sv) {
198 if ((mg = SvMAGIC(sv))) {
200 const MGVTBL* const vtbl = mg->mg_virtual;
202 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
209 } while ((mg = mg->mg_moremagic));
210 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
217 /* ... Safe version of call_sv() ........................................... */
219 #define VMG_SAVE_LAST_CX (!VMG_HAS_PERL(5, 8, 4) || VMG_HAS_PERL(5, 9, 5))
221 STATIC I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, I32 destructor) {
222 #define vmg_call_sv(S, F, D) vmg_call_sv(aTHX_ (S), (F), (D))
223 I32 ret, cxix = 0, in_eval = 0;
225 PERL_CONTEXT saved_cx;
234 if (cxstack_ix < cxstack_max) {
235 cxix = cxstack_ix + 1;
236 if (destructor && CxTYPE(cxstack + cxix) == CXt_EVAL)
241 /* The last popped context will be reused by call_sv(), but our callers may
242 * still need its previous value. Back it up so that it isn't clobbered. */
243 saved_cx = cxstack[cxix];
246 ret = call_sv(sv, flags | G_EVAL);
249 cxstack[cxix] = saved_cx;
254 sv_setsv(old_err, ERRSV);
258 if (IN_PERL_COMPILETIME) {
261 sv_catsv(PL_errors, ERRSV);
263 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
266 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
268 ++PL_parser->error_count;
269 #elif defined(PL_error_count)
286 /* --- Stolen chunk of B --------------------------------------------------- */
304 STATIC const char *const vmg_opclassnames[] = {
319 STATIC opclass vmg_opclass(const OP *o) {
326 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
328 if (o->op_type == OP_SASSIGN)
329 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
331 if (o->op_type == OP_AELEMFAST) {
332 #if PERL_VERSION <= 14
333 if (o->op_flags & OPf_SPECIAL)
345 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
349 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
366 case OA_PVOP_OR_SVOP:
367 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
372 case OA_BASEOP_OR_UNOP:
373 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
375 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
377 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
379 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
382 if (o->op_flags & OPf_STACKED)
384 else if (o->op_flags & OPf_SPECIAL)
393 /* --- Error messages ------------------------------------------------------ */
395 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
396 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
397 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
399 /* --- Context-safe global data -------------------------------------------- */
401 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
404 HV *b__op_stashes[OPc_MAX];
409 /* --- <vmg_vtable> structure ---------------------------------------------- */
418 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
419 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
422 t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
424 t->vtbl = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
430 #define vmg_vtable_vtbl(T) (T)->vtbl
433 STATIC perl_mutex vmg_vtable_refcount_mutex;
436 STATIC vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
437 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
438 VMG_LOCK(&vmg_vtable_refcount_mutex);
440 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
445 STATIC void vmg_vtable_free(pTHX_ vmg_vtable *t) {
446 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
449 VMG_LOCK(&vmg_vtable_refcount_mutex);
450 refcount = --t->refcount;
451 VMG_UNLOCK(&vmg_vtable_refcount_mutex);
454 PerlMemShared_free(t->vtbl);
455 PerlMemShared_free(t);
459 #else /* VMG_THREADSAFE */
461 typedef MGVTBL vmg_vtable;
463 STATIC vmg_vtable *vmg_vtable_alloc(pTHX) {
464 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
467 Newx(t, 1, vmg_vtable);
472 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
474 #define vmg_vtable_free(T) Safefree(T)
476 #endif /* !VMG_THREADSAFE */
478 /* --- <vmg_wizard> structure ---------------------------------------------- */
487 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
492 #endif /* MGf_LOCAL */
494 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
495 #endif /* VMG_UVAR */
498 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo);
500 STATIC vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
501 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
504 Newx(w, 1, vmg_wizard);
507 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
509 vmg_op_info_init(aTHX_ w->opinfo);
511 w->vtable = vmg_vtable_alloc();
516 STATIC void vmg_wizard_free(pTHX_ vmg_wizard *w) {
517 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
521 SvREFCNT_dec(w->cb_data);
522 SvREFCNT_dec(w->cb_get);
523 SvREFCNT_dec(w->cb_set);
524 SvREFCNT_dec(w->cb_len);
525 SvREFCNT_dec(w->cb_clear);
526 SvREFCNT_dec(w->cb_free);
527 SvREFCNT_dec(w->cb_copy);
529 SvREFCNT_dec(w->cb_dup);
532 SvREFCNT_dec(w->cb_local);
533 #endif /* MGf_LOCAL */
535 SvREFCNT_dec(w->cb_fetch);
536 SvREFCNT_dec(w->cb_store);
537 SvREFCNT_dec(w->cb_exists);
538 SvREFCNT_dec(w->cb_delete);
539 #endif /* VMG_UVAR */
541 vmg_vtable_free(w->vtable);
549 #define VMG_CLONE_CB(N) \
550 z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
553 STATIC const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
554 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
560 Newx(z, 1, vmg_wizard);
562 z->vtable = vmg_vtable_dup(w->vtable);
564 z->opinfo = w->opinfo;
576 #endif /* MGf_LOCAL */
580 VMG_CLONE_CB(exists);
581 VMG_CLONE_CB(delete);
582 #endif /* VMG_UVAR */
587 #endif /* VMG_THREADSAFE */
589 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
591 /* --- Wizard SV objects --------------------------------------------------- */
593 STATIC int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
594 if (PL_dirty) /* During global destruction, the context is already freed */
597 vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
604 STATIC int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
605 mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
610 #endif /* VMG_THREADSAFE */
612 STATIC MGVTBL vmg_wizard_sv_vtbl = {
617 vmg_wizard_sv_free, /* free */
620 vmg_wizard_sv_dup, /* dup */
626 #endif /* MGf_LOCAL */
629 STATIC SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
630 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
636 wiz = newSViv(PTR2IV(w));
640 MAGIC *mg = sv_magicext(wiz, NULL, PERL_MAGIC_ext, &vmg_wizard_sv_vtbl,
641 (const char *) w, 0);
644 mg->mg_flags |= MGf_DUP;
654 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
656 STATIC const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
659 for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
660 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
661 return (const vmg_wizard *) mg->mg_ptr;
667 #else /* VMG_THREADSAFE */
669 #define vmg_sv_has_wizard_type(S) SvIOK(S)
671 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
673 #endif /* !VMG_THREADSAFE */
675 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
677 STATIC const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
678 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
679 SV *sv = (SV *) mg->mg_ptr;
681 if (vmg_sv_has_wizard_type(sv))
682 return vmg_wizard_from_sv_nocheck(sv);
688 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
690 /* --- User-level functions implementation --------------------------------- */
692 STATIC const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
696 if (SvTYPE(sv) < SVt_PVMG)
699 wid = vmg_wizard_id(w);
701 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
702 const vmg_wizard *z = vmg_wizard_from_mg(mg);
704 if (z && vmg_wizard_id(z) == wid)
711 /* ... Construct private data .............................................. */
713 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
714 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
724 EXTEND(SP, items + 1);
725 PUSHs(sv_2mortal(newRV_inc(sv)));
726 for (i = 0; i < items; ++i)
730 vmg_call_sv(ctor, G_SCALAR, 0);
734 #if VMG_HAS_PERL(5, 8, 3)
735 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
737 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
747 STATIC SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
748 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
749 const MAGIC *mg = vmg_find(sv, w);
751 return mg ? mg->mg_obj : NULL;
754 /* ... Magic cast/dispell .................................................. */
757 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
759 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
761 prevmagic->mg_moremagic = moremagic;
763 SvMAGIC_set(sv, moremagic);
765 mg->mg_moremagic = NULL;
766 Safefree(mg->mg_ptr);
769 #endif /* VMG_UVAR */
771 STATIC UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
772 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
781 oldgmg = SvGMAGICAL(sv);
783 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
785 t = vmg_vtable_vtbl(w->vtable);
786 mg = sv_magicext(sv, data, PERL_MAGIC_ext, t, (const char *) wiz, HEf_SVKEY);
789 /* sv_magicext() calls mg_magical and increments data's refcount */
793 mg->mg_flags |= MGf_COPY;
796 mg->mg_flags |= MGf_DUP;
800 mg->mg_flags |= MGf_LOCAL;
801 #endif /* MGf_LOCAL */
803 if (SvTYPE(sv) < SVt_PVHV)
806 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
807 * magic is actually never called for them. If the GMAGICAL flag was off before
808 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
809 * now on, then this wizard has get magic. Hence we can work around the
810 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
811 * has uvar callbacks, it will be turned back on later. */
812 if (!oldgmg && SvGMAGICAL(sv))
817 MAGIC *prevmagic, *moremagic = NULL;
820 uf[0].uf_val = vmg_svt_val;
827 /* One uvar magic in the chain is enough. */
828 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
829 moremagic = mg->mg_moremagic;
830 if (mg->mg_type == PERL_MAGIC_uvar)
834 if (mg) { /* Found another uvar magic. */
835 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
836 if (olduf->uf_val == vmg_svt_val) {
837 /* It's our uvar magic, nothing to do. oldgmg was true. */
840 /* It's another uvar magic, backup it and replace it by ours. */
842 vmg_uvar_del(sv, prevmagic, mg, moremagic);
846 sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &uf, sizeof(uf));
848 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
849 * handled by our uvar callback. */
851 #endif /* VMG_UVAR */
857 STATIC UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
858 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
861 #endif /* VMG_UVAR */
862 MAGIC *mg, *prevmagic, *moremagic = NULL;
863 IV wid = vmg_wizard_id(w);
865 if (SvTYPE(sv) < SVt_PVMG)
868 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
871 moremagic = mg->mg_moremagic;
873 z = vmg_wizard_from_mg(mg);
875 IV zid = vmg_wizard_id(z);
879 /* If the current has no uvar, short-circuit uvar deletion. */
880 uvars = z->uvar ? (uvars + 1) : 0;
882 } else if (z->uvar) {
884 /* We can't break here since we need to find the ext magic to delete. */
889 #endif /* !VMG_UVAR */
896 prevmagic->mg_moremagic = moremagic;
898 SvMAGIC_set(sv, moremagic);
900 mg->mg_moremagic = NULL;
902 /* Destroy private data */
903 if (mg->mg_obj != sv)
904 SvREFCNT_dec(mg->mg_obj);
905 /* Unreference the wizard */
906 SvREFCNT_dec((SV *) mg->mg_ptr);
910 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
911 /* mg was the first ext magic in the chain that had uvar */
913 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
914 const vmg_wizard *z = vmg_wizard_from_mg(mg);
924 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
925 moremagic = mg->mg_moremagic;
926 if (mg->mg_type == PERL_MAGIC_uvar)
930 uf = (struct ufuncs *) mg->mg_ptr;
931 /* assert(uf->uf_val == vmg_svt_val); */
932 if (uf[1].uf_val || uf[1].uf_set) {
933 /* Revert the original uvar magic. */
935 Renew(uf, 1, struct ufuncs);
936 mg->mg_ptr = (char *) uf;
937 mg->mg_len = sizeof(struct ufuncs);
939 /* Remove the uvar magic. */
940 vmg_uvar_del(sv, prevmagic, mg, moremagic);
944 #endif /* VMG_UVAR */
951 /* ... OP info ............................................................. */
953 #define VMG_OP_INFO_NAME 1
954 #define VMG_OP_INFO_OBJECT 2
957 STATIC perl_mutex vmg_op_name_init_mutex;
960 STATIC U32 vmg_op_name_init = 0;
961 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
963 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
964 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
966 case VMG_OP_INFO_NAME:
967 VMG_LOCK(&vmg_op_name_init_mutex);
968 if (!vmg_op_name_init) {
970 for (t = 0; t < OP_max; ++t)
971 vmg_op_name_len[t] = strlen(PL_op_name[t]);
972 vmg_op_name_init = 1;
974 VMG_UNLOCK(&vmg_op_name_init_mutex);
976 case VMG_OP_INFO_OBJECT: {
978 if (!MY_CXT.b__op_stashes[0]) {
981 for (c = OPc_NULL; c < OPc_MAX; ++c)
982 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
991 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
992 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
997 case VMG_OP_INFO_NAME: {
998 OPCODE t = PL_op->op_type;
999 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
1001 case VMG_OP_INFO_OBJECT: {
1003 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1004 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1010 return &PL_sv_undef;
1013 /* ... svt callbacks ....................................................... */
1015 #define VMG_CB_CALL_ARGS_MASK 15
1016 #define VMG_CB_CALL_ARGS_SHIFT 4
1017 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
1019 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1022 unsigned int i, args, opinfo;
1027 args = flags & VMG_CB_CALL_ARGS_MASK;
1028 flags >>= VMG_CB_CALL_ARGS_SHIFT;
1029 opinfo = flags & VMG_CB_CALL_OPINFO;
1035 EXTEND(SP, args + 1);
1036 PUSHs(sv_2mortal(newRV_inc(sv)));
1038 for (i = 0; i < args; ++i) {
1039 SV *sva = va_arg(ap, SV *);
1040 PUSHs(sva ? sva : &PL_sv_undef);
1044 XPUSHs(vmg_op_info(opinfo));
1047 vmg_call_sv(cb, G_SCALAR, 0);
1052 ret = (int) SvIV(svr);
1061 #define VMG_CB_FLAGS(OI, A) \
1062 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1064 #define vmg_cb_call1(I, OI, S, A1) \
1065 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1066 #define vmg_cb_call2(I, OI, S, A1, A2) \
1067 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1068 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1069 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1071 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1072 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1074 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1077 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1078 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1080 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1083 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1084 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1085 unsigned int opinfo = w->opinfo;
1088 svtype t = SvTYPE(sv);
1097 PUSHs(sv_2mortal(newRV_inc(sv)));
1098 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1101 #if VMG_HAS_PERL(5, 9, 3)
1102 const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, l)));
1104 U8 *s = SvPV(sv, l);
1107 len = utf8_length(s, s + l);
1111 } else if (t == SVt_PVAV) {
1112 len = av_len((AV *) sv) + 1;
1116 PUSHs(&PL_sv_undef);
1119 XPUSHs(vmg_op_info(opinfo));
1122 vmg_call_sv(w->cb_len, G_SCALAR, 0);
1126 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1137 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1138 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1140 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
1143 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1144 const vmg_wizard *w;
1150 /* Don't even bother if we are in global destruction - the wizard is prisoner
1151 * of circular references and we are way beyond user realm */
1155 w = vmg_wizard_from_mg_nocheck(mg);
1157 /* So that it survives the temp cleanup below */
1158 SvREFCNT_inc_simple_void(sv);
1160 #if !(VMG_HAS_PERL_MAINT(5, 11, 0, 32686) || VMG_HAS_PERL(5, 12, 0))
1161 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1162 * if you access the sv from the callback the old deleted magics will trigger
1163 * and cause memory misreads. Change 32686 solved it that way : */
1164 SvMAGIC_set(sv, mg);
1172 PUSHs(sv_2mortal(newRV_inc(sv)));
1173 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1175 XPUSHs(vmg_op_info(w->opinfo));
1178 vmg_call_sv(w->cb_free, G_SCALAR, 1);
1183 ret = (int) SvIV(svr);
1189 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1190 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1193 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1194 * mg->mg_ptr reference count */
1198 #if VMG_HAS_PERL_MAINT(5, 11, 0, 33256) || VMG_HAS_PERL(5, 12, 0)
1199 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1201 # define VMG_SVT_COPY_KEYLEN_TYPE int
1204 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1205 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1209 if (keylen == HEf_SVKEY) {
1212 keysv = newSVpvn(key, keylen);
1215 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1217 if (keylen != HEf_SVKEY) {
1218 SvREFCNT_dec(keysv);
1225 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1231 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1232 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1234 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1236 #endif /* MGf_LOCAL */
1239 STATIC OP *vmg_pp_resetuvar(pTHX) {
1240 SvRMAGICAL_on(cSVOP_sv);
1244 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1247 SV *key = NULL, *newkey = NULL;
1250 umg = mg_find(sv, PERL_MAGIC_uvar);
1251 /* umg can't be NULL or we wouldn't be there. */
1253 uf = (struct ufuncs *) umg->mg_ptr;
1256 uf[1].uf_val(aTHX_ action, sv);
1258 uf[1].uf_set(aTHX_ action, sv);
1260 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
1261 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
1262 const vmg_wizard *w;
1263 switch (mg->mg_type) {
1264 case PERL_MAGIC_ext:
1266 case PERL_MAGIC_tied:
1272 w = vmg_wizard_from_mg(mg);
1279 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1284 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
1286 case HV_FETCH_ISSTORE:
1287 case HV_FETCH_LVALUE:
1288 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1290 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1292 case HV_FETCH_ISEXISTS:
1294 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1298 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1303 if (SvRMAGICAL(sv) && !tied) {
1304 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1305 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1306 * the op_ppaddr of a new fake op injected between the current and the next
1309 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1311 NewOp(1101, svop, 1, SVOP);
1312 svop->op_type = OP_STUB;
1313 svop->op_ppaddr = vmg_pp_resetuvar;
1314 svop->op_next = o->op_next;
1317 o->op_next = (OP *) svop;
1324 #endif /* VMG_UVAR */
1326 /* --- Macros for the XS section ------------------------------------------- */
1328 #define VMG_SET_CB(S, N) \
1330 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? SvREFCNT_inc(SvRV(cb)) : NULL;
1332 #define VMG_SET_SVT_CB(S, N) \
1334 if (SvOK(cb) && SvROK(cb)) { \
1335 t->svt_ ## N = vmg_svt_ ## N; \
1336 w->cb_ ## N = SvREFCNT_inc(SvRV(cb)); \
1338 t->svt_ ## N = NULL; \
1339 w->cb_ ## N = NULL; \
1342 /* --- XS ------------------------------------------------------------------ */
1344 MODULE = Variable::Magic PACKAGE = Variable::Magic
1353 MY_CXT.b__op_stashes[0] = NULL;
1355 MUTEX_INIT(&vmg_vtable_refcount_mutex);
1356 MUTEX_INIT(&vmg_op_name_init_mutex);
1359 stash = gv_stashpv(__PACKAGE__, 1);
1360 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1361 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1362 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1363 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1364 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1365 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1366 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1367 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1368 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1369 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1370 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1371 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1372 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1373 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1374 newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1375 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1376 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1377 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1378 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1379 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1388 U32 had_b__op_stash = 0;
1393 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1394 if (MY_CXT.b__op_stashes[c])
1395 had_b__op_stash |= (((U32) 1) << c);
1400 for (c = OPc_NULL; c < OPc_MAX; ++c) {
1401 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1402 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1407 #endif /* VMG_THREADSAFE */
1414 SV *cb, *op_info, *copy_key;
1420 #endif /* MGf_LOCAL */
1423 #endif /* VMG_UVAR */
1424 ) { croak(vmg_wrongargnum); }
1427 w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1428 t = vmg_vtable_vtbl(w->vtable);
1430 VMG_SET_CB(ST(i++), data);
1432 VMG_SET_SVT_CB(ST(i++), get);
1433 VMG_SET_SVT_CB(ST(i++), set);
1434 VMG_SET_SVT_CB(ST(i++), len);
1435 VMG_SET_SVT_CB(ST(i++), clear);
1436 VMG_SET_SVT_CB(ST(i++), free);
1437 VMG_SET_SVT_CB(ST(i++), copy);
1438 /* VMG_SET_SVT_CB(ST(i++), dup); */
1443 VMG_SET_SVT_CB(ST(i++), local);
1444 #endif /* MGf_LOCAL */
1446 VMG_SET_CB(ST(i++), fetch);
1447 VMG_SET_CB(ST(i++), store);
1448 VMG_SET_CB(ST(i++), exists);
1449 VMG_SET_CB(ST(i++), delete);
1452 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1453 w->uvar = SvTRUE(copy_key) ? 2 : 1;
1454 #endif /* VMG_UVAR */
1456 RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
1460 SV *cast(SV *sv, SV *wiz, ...)
1461 PROTOTYPE: \[$@%&*]$@
1463 const vmg_wizard *w = NULL;
1473 wiz = SvRV_const(wiz);
1474 w = vmg_wizard_from_sv(wiz);
1477 croak(vmg_invalid_wiz);
1478 RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
1483 getdata(SV *sv, SV *wiz)
1484 PROTOTYPE: \[$@%&*]$
1486 const vmg_wizard *w = NULL;
1490 w = vmg_wizard_from_sv(SvRV_const(wiz));
1492 croak(vmg_invalid_wiz);
1493 data = vmg_data_get(SvRV(sv), w);
1499 SV *dispell(SV *sv, SV *wiz)
1500 PROTOTYPE: \[$@%&*]$
1502 const vmg_wizard *w = NULL;
1505 w = vmg_wizard_from_sv(SvRV_const(wiz));
1507 croak(vmg_invalid_wiz);
1508 RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));