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))
83 param.stashes = NULL; /* don't need it unless sv is a PVHV */
85 param.proto_perl = owner;
86 return sv_dup(sv, ¶m);
89 #endif /* VMG_THREADSAFE */
91 /* --- Compatibility ------------------------------------------------------- */
94 # define Newx(v, n, c) New(0, v, n, c)
98 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
102 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
106 # define SvPV_const SvPV
109 #ifndef PERL_MAGIC_ext
110 # define PERL_MAGIC_ext '~'
113 #ifndef PERL_MAGIC_tied
114 # define PERL_MAGIC_tied 'P'
129 #ifndef IN_PERL_COMPILETIME
130 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
133 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
134 # ifndef PL_error_count
135 # define PL_error_count PL_parser->error_count
138 # ifndef PL_error_count
139 # define PL_error_count PL_Ierror_count
143 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but only
144 * enable it on 5.10 */
145 #if VMG_HAS_PERL(5, 10, 0)
151 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
152 * reverted to dev-5.11 as 9cdcb38b */
153 #if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
154 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
155 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
157 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
158 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
161 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
162 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
164 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
165 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
169 /* Applied to dev-5.11 as 34908 */
170 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
171 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
173 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
176 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
177 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
178 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
180 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
183 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
184 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
186 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
191 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
192 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
193 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
195 sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
196 /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
197 if ((mg = SvMAGIC(sv))) {
200 const MGVTBL* const vtbl = mg->mg_virtual;
202 if (vtbl->svt_clear) {
207 } while ((mg = mg->mg_moremagic));
211 #endif /* VMG_UVAR */
213 /* --- Stolen chunk of B --------------------------------------------------- */
231 STATIC const char *const vmg_opclassnames[] = {
246 STATIC opclass vmg_opclass(const OP *o) {
253 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
255 if (o->op_type == OP_SASSIGN)
256 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
258 if (o->op_type == OP_AELEMFAST) {
259 if (o->op_flags & OPf_SPECIAL)
270 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
274 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
291 case OA_PVOP_OR_SVOP:
292 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
297 case OA_BASEOP_OR_UNOP:
298 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
300 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
302 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
304 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
307 if (o->op_flags & OPf_STACKED)
309 else if (o->op_flags & OPf_SPECIAL)
318 /* --- Context-safe global data -------------------------------------------- */
320 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
324 HV *b__op_stashes[OPc_MAX];
329 /* --- Error messages ------------------------------------------------------ */
331 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
332 STATIC const char vmg_invalid_sig[] = "Invalid numeric signature";
333 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
334 STATIC const char vmg_toomanysigs[] = "Too many magic signatures used";
335 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
336 STATIC const char vmg_globstorefail[] = "Couldn't store global wizard information";
338 /* --- Signatures ---------------------------------------------------------- */
340 #define SIG_MIN ((U16) 0u)
341 #define SIG_MAX ((U16) ((1u << 16) - 1))
342 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
344 #define SIG_WZO ((U16) (0x3891))
345 #define SIG_WIZ ((U16) (0x3892))
347 /* ... Generate signatures ................................................. */
349 STATIC U16 vmg_gensig(pTHX) {
350 #define vmg_gensig() vmg_gensig(aTHX)
355 if (HvKEYS(MY_CXT.wizards) >= SIG_NBR) croak(vmg_toomanysigs);
358 sig = SIG_NBR * Drand01() + SIG_MIN;
359 } while (hv_exists(MY_CXT.wizards, buf, sprintf(buf, "%u", sig)));
364 /* --- MGWIZ structure ----------------------------------------------------- */
374 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
377 #endif /* MGf_COPY */
383 #endif /* MGf_LOCAL */
385 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
386 #endif /* VMG_UVAR */
389 #endif /* VMG_MULTIPLICITY */
392 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
393 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
395 /* ... Construct private data .............................................. */
397 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
398 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
400 I32 i, alen = (args == NULL) ? 0 : av_len(args);
408 EXTEND(SP, alen + 1);
409 PUSHs(sv_2mortal(newRV_inc(sv)));
410 for (i = 0; i < alen; ++i)
411 PUSHs(*av_fetch(args, i, 0));
414 call_sv(ctor, G_SCALAR);
418 #if VMG_HAS_PERL(5, 8, 3)
419 SvREFCNT_inc(nsv); /* Or it will be destroyed in FREETMPS */
421 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
431 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
432 MAGIC *mg, *moremagic;
434 if (SvTYPE(sv) >= SVt_PVMG) {
435 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
436 moremagic = mg->mg_moremagic;
437 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
438 MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
450 /* ... Magic cast/dispell .................................................. */
453 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
455 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
457 prevmagic->mg_moremagic = moremagic;
459 SvMAGIC_set(sv, moremagic);
461 mg->mg_moremagic = NULL;
462 Safefree(mg->mg_ptr);
465 #endif /* VMG_UVAR */
467 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
468 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
469 MAGIC *mg = NULL, *moremagic = NULL;
472 U32 oldgmg = SvGMAGICAL(sv);
476 if (SvTYPE(sv) >= SVt_PVMG) {
477 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
478 moremagic = mg->mg_moremagic;
479 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
480 MGWIZ *z = SV2MGWIZ(mg->mg_ptr);
481 if (z->sig == w->sig)
489 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
490 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
491 mg->mg_private = SIG_WIZ;
494 mg->mg_flags |= MGf_COPY;
495 #endif /* MGf_COPY */
498 mg->mg_flags |= MGf_DUP;
502 mg->mg_flags |= MGf_LOCAL;
503 #endif /* MGf_LOCAL */
505 if (SvTYPE(sv) < SVt_PVHV)
508 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
509 * magic is actually never called for them. If the GMAGICAL flag was off before
510 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
511 * now on, then this wizard has get magic. Hence we can work around the
512 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
513 * has uvar callbacks, it will be turned back on later. */
514 if (!oldgmg && SvGMAGICAL(sv))
522 uf[0].uf_val = vmg_svt_val;
529 /* One uvar magic in the chain is enough. */
530 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
531 moremagic = mg->mg_moremagic;
532 if (mg->mg_type == PERL_MAGIC_uvar)
536 if (mg) { /* Found another uvar magic. */
537 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
538 if (olduf->uf_val == vmg_svt_val) {
539 /* It's our uvar magic, nothing to do. oldgmg was true. */
542 /* It's another uvar magic, backup it and replace it by ours. */
544 vmg_uvar_del(sv, prevmagic, mg, moremagic);
548 vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
549 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
550 * handled by our uvar callback. */
552 #endif /* VMG_UVAR */
558 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
559 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
562 #endif /* VMG_UVAR */
563 MAGIC *mg, *prevmagic, *moremagic = NULL;
565 if (SvTYPE(sv) < SVt_PVMG)
568 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
569 moremagic = mg->mg_moremagic;
570 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
571 MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
574 /* If the current has no uvar, short-circuit uvar deletion. */
575 uvars = w->uvar ? (uvars + 1) : 0;
576 #endif /* VMG_UVAR */
579 } else if (w->uvar) {
581 /* We can't break here since we need to find the ext magic to delete. */
582 #endif /* VMG_UVAR */
590 prevmagic->mg_moremagic = moremagic;
592 SvMAGIC_set(sv, moremagic);
594 mg->mg_moremagic = NULL;
596 /* Destroy private data */
597 if (mg->mg_obj != sv)
598 SvREFCNT_dec(mg->mg_obj);
599 /* Unreference the wizard */
600 SvREFCNT_dec((SV *) mg->mg_ptr);
604 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
605 /* mg was the first ext magic in the chain that had uvar */
607 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
608 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
609 MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
619 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
620 moremagic = mg->mg_moremagic;
621 if (mg->mg_type == PERL_MAGIC_uvar)
625 uf = (struct ufuncs *) mg->mg_ptr;
626 /* assert(uf->uf_val == vmg_svt_val); */
627 if (uf[1].uf_val || uf[1].uf_set) {
628 /* Revert the original uvar magic. */
630 Renew(uf, 1, struct ufuncs);
631 mg->mg_ptr = (char *) uf;
632 mg->mg_len = sizeof(struct ufuncs);
634 /* Remove the uvar magic. */
635 vmg_uvar_del(sv, prevmagic, mg, moremagic);
639 #endif /* VMG_UVAR */
644 /* ... OP info ............................................................. */
646 #define VMG_OP_INFO_NAME 1
647 #define VMG_OP_INFO_OBJECT 2
650 STATIC perl_mutex vmg_op_name_init_mutex;
653 STATIC U32 vmg_op_name_init = 0;
654 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
656 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
657 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
659 case VMG_OP_INFO_NAME:
661 MUTEX_LOCK(&vmg_op_name_init_mutex);
663 if (!vmg_op_name_init) {
665 for (t = 0; t < OP_max; ++t)
666 vmg_op_name_len[t] = strlen(PL_op_name[t]);
667 vmg_op_name_init = 1;
670 MUTEX_UNLOCK(&vmg_op_name_init_mutex);
673 case VMG_OP_INFO_OBJECT: {
675 if (!MY_CXT.b__op_stashes[0]) {
678 for (c = 0; c < OPc_MAX; ++c)
679 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
688 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
689 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
694 case VMG_OP_INFO_NAME: {
695 OPCODE t = PL_op->op_type;
696 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
698 case VMG_OP_INFO_OBJECT: {
700 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
701 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
710 /* ... svt callbacks ....................................................... */
712 #define VMG_CB_CALL_SET_RET(D) \
717 ret = SvOK(svr) ? SvIV(svr) : (D); \
721 #define VMG_CB_CALL_ARGS_MASK 15
722 #define VMG_CB_CALL_ARGS_SHIFT 4
723 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
725 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
728 unsigned int i, args, opinfo;
732 args = flags & VMG_CB_CALL_ARGS_MASK;
733 flags >>= VMG_CB_CALL_ARGS_SHIFT;
734 opinfo = flags & VMG_CB_CALL_OPINFO;
740 EXTEND(SP, args + 1);
741 PUSHs(sv_2mortal(newRV_inc(sv)));
743 for (i = 0; i < args; ++i) {
744 SV *sva = va_arg(ap, SV *);
745 PUSHs(sva ? sva : &PL_sv_undef);
749 XPUSHs(vmg_op_info(opinfo));
752 call_sv(cb, G_SCALAR);
754 VMG_CB_CALL_SET_RET(0);
762 #define vmg_cb_call1(I, F, S, A1) \
763 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
764 #define vmg_cb_call2(I, F, S, A1, A2) \
765 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
766 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
767 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
769 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
770 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
771 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
774 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
775 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
776 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
779 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
780 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
781 unsigned int opinfo = w->opinfo;
783 svtype t = SvTYPE(sv);
792 PUSHs(sv_2mortal(newRV_inc(sv)));
793 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
796 U8 *s = (U8 *) SvPV_const(sv, l);
798 len = utf8_length(s, s + l);
802 } else if (t == SVt_PVAV) {
803 len = av_len((AV *) sv) + 1;
810 XPUSHs(vmg_op_info(opinfo));
813 call_sv(w->cb_len, G_SCALAR);
815 VMG_CB_CALL_SET_RET(len);
820 return t == SVt_PVAV ? ret - 1 : ret;
823 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
824 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
825 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
828 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
830 #if VMG_HAS_PERL(5, 9, 5)
831 PERL_CONTEXT saved_cx;
834 unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
839 /* Don't even bother if we are in global destruction - the wizard is prisoner
840 * of circular references and we are way beyond user realm */
844 w = SV2MGWIZ(mg->mg_ptr);
846 /* So that it survives the temp cleanup below */
849 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
850 /* The previous magic tokens were freed but the magic chain wasn't updated, so
851 * if you access the sv from the callback the old deleted magics will trigger
852 * and cause memory misreads. Change 32686 solved it that way : */
861 PUSHs(sv_2mortal(newRV_inc(sv)));
862 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
864 XPUSHs(vmg_op_info(w->opinfo));
867 had_err = SvTRUE(ERRSV);
871 #if VMG_HAS_PERL(5, 9, 5)
872 /* This context should not be used anymore, but since we croak in places the
873 * core doesn't even dare to, some pointers to it may remain in the upper call
874 * stack. Make sure call_sv() doesn't clobber it. */
875 if (cxstack_ix < cxstack_max)
876 cxix = cxstack_ix + 1;
878 cxix = Perl_cxinc(aTHX);
879 saved_cx = cxstack[cxix];
882 call_sv(w->cb_free, flags);
884 #if VMG_HAS_PERL(5, 9, 5)
885 cxstack[cxix] = saved_cx;
888 has_err = SvTRUE(ERRSV);
889 if (IN_PERL_COMPILETIME && !had_err && has_err)
892 VMG_CB_CALL_SET_RET(0);
897 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
898 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
901 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
902 * mg->mg_ptr reference count */
907 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
908 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
915 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
918 if (keylen == HEf_SVKEY) {
921 keysv = newSVpvn(key, keylen);
924 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
926 if (keylen != HEf_SVKEY) {
932 #endif /* MGf_COPY */
935 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
941 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
942 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
943 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
945 #endif /* MGf_LOCAL */
948 STATIC OP *vmg_pp_resetuvar(pTHX) {
949 SvRMAGICAL_on(cSVOP_sv);
953 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
956 SV *key = NULL, *newkey = NULL;
959 umg = mg_find(sv, PERL_MAGIC_uvar);
960 /* umg can't be NULL or we wouldn't be there. */
962 uf = (struct ufuncs *) umg->mg_ptr;
965 uf[1].uf_val(aTHX_ action, sv);
967 uf[1].uf_set(aTHX_ action, sv);
969 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
970 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
972 switch (mg->mg_type) {
975 case PERL_MAGIC_tied:
981 if (mg->mg_private != SIG_WIZ) continue;
982 w = SV2MGWIZ(mg->mg_ptr);
988 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
993 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
995 case HV_FETCH_ISSTORE:
996 case HV_FETCH_LVALUE:
997 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
999 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
1001 case HV_FETCH_ISEXISTS:
1003 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
1007 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
1012 if (SvRMAGICAL(sv) && !tied) {
1013 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1014 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1015 * the op_ppaddr of a new fake op injected between the current and the next
1018 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
1020 NewOp(1101, svop, 1, SVOP);
1021 svop->op_type = OP_STUB;
1022 svop->op_ppaddr = vmg_pp_resetuvar;
1023 svop->op_next = o->op_next;
1026 o->op_next = (OP *) svop;
1033 #endif /* VMG_UVAR */
1035 /* ... Wizard destructor ................................................... */
1037 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
1041 if (PL_dirty) /* During global destruction, the context is already freed */
1045 #if VMG_MULTIPLICITY
1046 if (w->owner != aTHX)
1049 #endif /* VMG_MULTIPLICITY */
1053 if (hv_delete(MY_CXT.wizards, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
1057 /* Unmortalize the wizard to avoid it being freed in weird places. */
1058 if (SvTEMP(wiz) && !SvREFCNT(wiz)) {
1059 const I32 myfloor = PL_tmps_floor;
1061 for (i = PL_tmps_ix; i > myfloor; --i) {
1062 if (PL_tmps_stack[i] == wiz)
1063 PL_tmps_stack[i] = NULL;
1067 if (w->cb_data) SvREFCNT_dec(SvRV(w->cb_data));
1068 if (w->cb_get) SvREFCNT_dec(SvRV(w->cb_get));
1069 if (w->cb_set) SvREFCNT_dec(SvRV(w->cb_set));
1070 if (w->cb_len) SvREFCNT_dec(SvRV(w->cb_len));
1071 if (w->cb_clear) SvREFCNT_dec(SvRV(w->cb_clear));
1072 if (w->cb_free) SvREFCNT_dec(SvRV(w->cb_free));
1074 if (w->cb_copy) SvREFCNT_dec(SvRV(w->cb_copy));
1075 #endif /* MGf_COPY */
1077 if (w->cb_dup) SvREFCNT_dec(SvRV(w->cb_dup));
1078 #endif /* MGf_DUP */
1080 if (w->cb_local) SvREFCNT_dec(SvRV(w->cb_local));
1081 #endif /* MGf_LOCAL */
1083 if (w->cb_fetch) SvREFCNT_dec(SvRV(w->cb_fetch));
1084 if (w->cb_store) SvREFCNT_dec(SvRV(w->cb_store));
1085 if (w->cb_exists) SvREFCNT_dec(SvRV(w->cb_exists));
1086 if (w->cb_delete) SvREFCNT_dec(SvRV(w->cb_delete));
1087 #endif /* VMG_UVAR */
1095 STATIC MGVTBL vmg_wizard_vtbl = {
1100 vmg_wizard_free, /* free */
1103 #endif /* MGf_COPY */
1106 #endif /* MGf_DUP */
1109 #endif /* MGf_LOCAL */
1112 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
1113 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
1118 } else if (SvNOK(sv)) {
1120 } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
1123 croak(vmg_invalid_sig);
1126 if (sig < SIG_MIN || sig > SIG_MAX)
1127 croak(vmg_invalid_sig);
1132 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
1133 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
1137 sig = SV2MGWIZ(SvRV(wiz))->sig;
1138 } else if (SvOK(wiz)) {
1139 sig = vmg_sv2sig(wiz);
1141 croak(vmg_invalid_wiz);
1147 SV **old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0);
1148 if (!(old && SV2MGWIZ(*old)))
1149 croak(vmg_invalid_wiz);
1155 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
1156 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
1161 #if VMG_MULTIPLICITY
1162 if (SV2MGWIZ(wiz)->owner == aTHX)
1164 #endif /* VMG_MULTIPLICITY */
1165 sig = SV2MGWIZ(wiz)->sig;
1166 } else if (SvOK(wiz)) {
1167 sig = vmg_sv2sig(wiz);
1169 croak(vmg_invalid_wiz);
1175 SV **old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0);
1176 if (!(old && SV2MGWIZ(*old)))
1177 croak(vmg_invalid_wiz);
1183 #define VMG_SET_CB(S, N) \
1185 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1187 #define VMG_SET_SVT_CB(S, N) \
1189 if (SvOK(cb) && SvROK(cb)) { \
1190 t->svt_ ## N = vmg_svt_ ## N; \
1191 w->cb_ ## N = newRV_inc(SvRV(cb)); \
1193 t->svt_ ## N = NULL; \
1194 w->cb_ ## N = NULL; \
1199 #define VMG_CLONE_CB(N) \
1200 z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
1204 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
1205 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
1210 Copy(w->vtbl, t, 1, MGVTBL);
1217 VMG_CLONE_CB(clear);
1221 #endif /* MGf_COPY */
1224 #endif /* MGf_DUP */
1226 VMG_CLONE_CB(local);
1227 #endif /* MGf_LOCAL */
1229 VMG_CLONE_CB(fetch);
1230 VMG_CLONE_CB(store);
1231 VMG_CLONE_CB(exists);
1232 VMG_CLONE_CB(delete);
1233 #endif /* VMG_UVAR */
1238 z->opinfo = w->opinfo;
1243 #endif /* VMG_THREADSAFE */
1245 /* --- XS ------------------------------------------------------------------ */
1247 MODULE = Variable::Magic PACKAGE = Variable::Magic
1255 MY_CXT.wizards = newHV();
1256 hv_iterinit(MY_CXT.wizards); /* Allocate iterator */
1257 MY_CXT.b__op_stashes[0] = NULL;
1259 MUTEX_INIT(&vmg_op_name_init_mutex);
1262 stash = gv_stashpv(__PACKAGE__, 1);
1263 newCONSTSUB(stash, "SIG_MIN", newSVuv(SIG_MIN));
1264 newCONSTSUB(stash, "SIG_MAX", newSVuv(SIG_MAX));
1265 newCONSTSUB(stash, "SIG_NBR", newSVuv(SIG_NBR));
1266 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1267 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1268 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1269 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1270 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1271 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1272 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1273 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1274 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1275 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1276 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1277 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1278 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1279 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1280 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1281 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1282 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(VMG_FORKSAFE));
1283 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1284 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1294 U32 had_b__op_stash = 0;
1301 hv_iterinit(hv); /* Allocate iterator */
1302 hv_iterinit(MY_CXT.wizards);
1303 while ((key = hv_iternext(MY_CXT.wizards))) {
1305 char *sig = HePV(key, len);
1307 const MGWIZ *w = SV2MGWIZ(HeVAL(key));
1310 w = vmg_wizard_clone(w);
1312 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1313 mg->mg_private = SIG_WZO;
1315 sv = MGWIZ2SV(NULL);
1318 if (!hv_store(hv, sig, len, sv, HeHASH(key))) croak("%s during CLONE", vmg_globstorefail);
1320 for (c = 0; c < OPc_MAX; ++c) {
1321 if (MY_CXT.b__op_stashes[c])
1322 had_b__op_stash |= (((U32) 1) << c);
1327 MY_CXT.wizards = hv;
1328 for (c = 0; c < OPc_MAX; ++c) {
1329 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1330 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1334 #endif /* VMG_THREADSAFE */
1354 #endif /* MGf_COPY */
1357 #endif /* MGf_DUP */
1360 #endif /* MGf_LOCAL */
1363 #endif /* VMG_UVAR */
1364 ) { croak(vmg_wrongargnum); }
1369 sig = vmg_sv2sig(svsig);
1370 old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0);
1371 if (old && SV2MGWIZ(*old)) {
1372 ST(0) = sv_2mortal(newRV_inc(*old));
1382 VMG_SET_CB(ST(i++), data);
1384 w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1386 vmg_op_info_init(w->opinfo);
1387 VMG_SET_SVT_CB(ST(i++), get);
1388 VMG_SET_SVT_CB(ST(i++), set);
1389 VMG_SET_SVT_CB(ST(i++), len);
1390 VMG_SET_SVT_CB(ST(i++), clear);
1391 VMG_SET_SVT_CB(ST(i++), free);
1393 VMG_SET_SVT_CB(ST(i++), copy);
1394 #endif /* MGf_COPY */
1396 /* VMG_SET_SVT_CB(ST(i++), dup); */
1400 #endif /* MGf_DUP */
1402 VMG_SET_SVT_CB(ST(i++), local);
1403 #endif /* MGf_LOCAL */
1405 VMG_SET_CB(ST(i++), fetch);
1406 VMG_SET_CB(ST(i++), store);
1407 VMG_SET_CB(ST(i++), exists);
1408 VMG_SET_CB(ST(i++), delete);
1410 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1411 w->uvar = SvTRUE(cb) ? 2 : 1;
1414 #endif /* VMG_UVAR */
1415 #if VMG_MULTIPLICITY
1417 #endif /* VMG_MULTIPLICITY */
1422 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1423 mg->mg_private = SIG_WZO;
1426 if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), sv, 0)) croak(vmg_globstorefail);
1428 RETVAL = newRV_noinc(sv);
1440 if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), MGWIZ2SV(NULL), 0)) croak(vmg_globstorefail);
1441 RETVAL = newSVuv(sig);
1450 sig = vmg_wizard_sig(wiz);
1451 RETVAL = newSVuv(sig);
1455 SV *cast(SV *sv, SV *wiz, ...)
1456 PROTOTYPE: \[$@%&*]$@
1461 wiz = vmg_wizard_wiz(wiz);
1465 av_fill(args, items - 2);
1466 for (i = 2; i < items; ++i) {
1469 if (av_store(args, i - 2, arg) == NULL) croak(vmg_argstorefailed);
1472 ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1479 getdata(SV *sv, SV *wiz)
1480 PROTOTYPE: \[$@%&*]$
1485 sig = vmg_wizard_sig(wiz);
1486 data = vmg_data_get(SvRV(sv), sig);
1492 SV *dispell(SV *sv, SV *wiz)
1493 PROTOTYPE: \[$@%&*]$
1497 sig = vmg_wizard_sig(wiz);
1498 RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));