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 #ifndef VMG_MULTIPLICITY
40 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
41 # define VMG_MULTIPLICITY 1
43 # define VMG_MULTIPLICITY 0
46 #if VMG_MULTIPLICITY && !defined(tTHX)
47 # define tTHX PerlInterpreter*
50 #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))
51 # define VMG_THREADSAFE 1
53 # define MY_CXT_CLONE \
55 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
56 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
57 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
60 # define VMG_THREADSAFE 0
62 # define dMY_CXT dNOOP
64 # define MY_CXT vmg_globaldata
66 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
68 # define MY_CXT_INIT NOOP
70 # define MY_CXT_CLONE NOOP
75 STATIC SV *vmg_clone(pTHX_ SV *sv, tTHX owner) {
76 #define vmg_clone(P, O) vmg_clone(aTHX_ (P), (O))
78 param.stashes = NULL; /* don't need it unless sv is a PVHV */
80 param.proto_perl = owner;
81 return sv_dup(sv, ¶m);
84 #endif /* VMG_THREADSAFE */
86 /* --- Compatibility ------------------------------------------------------- */
89 # define Newx(v, n, c) New(0, v, n, c)
93 # define NewOp(m, var, c, type) Newz(m, var, c, type)
97 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
101 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
105 # define SvPV_const SvPV
108 #ifndef PERL_MAGIC_ext
109 # define PERL_MAGIC_ext '~'
112 #ifndef PERL_MAGIC_tied
113 # define PERL_MAGIC_tied 'P'
128 #ifndef IN_PERL_COMPILETIME
129 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
132 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
133 # ifndef PL_error_count
134 # define PL_error_count PL_parser->error_count
137 # ifndef PL_error_count
138 # define PL_error_count PL_Ierror_count
142 /* uvar magic and Hash::Util::FieldHash were commited with 28419 */
143 #if VMG_HAS_PERL_MAINT(5, 9, 4, 28419) || VMG_HAS_PERL(5, 10, 0)
149 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160 */
150 #ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
151 # if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
152 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
154 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
158 /* Applied to dev-5.11 as 34908 */
159 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
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)
173 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
175 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
180 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
181 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
182 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
184 sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
185 /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
186 if ((mg = SvMAGIC(sv))) {
189 const MGVTBL* const vtbl = mg->mg_virtual;
191 if (vtbl->svt_clear) {
196 } while ((mg = mg->mg_moremagic));
200 #endif /* VMG_UVAR */
202 /* --- Stolen chunk of B --------------------------------------------------- */
220 STATIC const char *const vmg_opclassnames[] = {
235 STATIC opclass vmg_opclass(const OP *o) {
240 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
242 if (o->op_type == OP_SASSIGN)
243 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
245 if (o->op_type == OP_AELEMFAST) {
246 if (o->op_flags & OPf_SPECIAL)
257 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
261 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
278 case OA_PVOP_OR_SVOP:
279 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)) ? OPc_SVOP : OPc_PVOP;
284 case OA_BASEOP_OR_UNOP:
285 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
287 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
289 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
291 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
294 if (o->op_flags & OPf_STACKED)
296 else if (o->op_flags & OPf_SPECIAL)
305 /* --- Context-safe global data -------------------------------------------- */
307 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
311 HV *b__op_stashes[OPc_MAX];
316 /* --- Error messages ------------------------------------------------------ */
318 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
319 STATIC const char vmg_invalid_sig[] = "Invalid numeric signature";
320 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
321 STATIC const char vmg_toomanysigs[] = "Too many magic signatures used";
322 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
323 STATIC const char vmg_globstorefail[] = "Couldn't store global wizard information";
325 /* --- Signatures ---------------------------------------------------------- */
327 #define SIG_MIN ((U16) 0u)
328 #define SIG_MAX ((U16) ((1u << 16) - 1))
329 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
331 #define SIG_WZO ((U16) (0x3891))
332 #define SIG_WIZ ((U16) (0x3892))
334 /* ... Generate signatures ................................................. */
336 STATIC U16 vmg_gensig(pTHX) {
337 #define vmg_gensig() vmg_gensig(aTHX)
342 if (HvKEYS(MY_CXT.wizards) >= SIG_NBR)
343 croak(vmg_toomanysigs);
346 sig = SIG_NBR * Drand01() + SIG_MIN;
347 } while (hv_exists(MY_CXT.wizards, buf, sprintf(buf, "%u", sig)));
352 /* --- MGWIZ structure ----------------------------------------------------- */
362 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
365 #endif /* MGf_COPY */
371 #endif /* MGf_LOCAL */
373 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
374 #endif /* VMG_UVAR */
377 #endif /* VMG_MULTIPLICITY */
380 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
381 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
383 /* ... Construct private data .............................................. */
385 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
386 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
388 I32 i, alen = (args == NULL) ? 0 : av_len(args);
396 EXTEND(SP, alen + 1);
397 PUSHs(sv_2mortal(newRV_inc(sv)));
398 for (i = 0; i < alen; ++i)
399 PUSHs(*av_fetch(args, i, 0));
402 call_sv(ctor, G_SCALAR);
406 #if VMG_HAS_PERL(5, 8, 3)
407 SvREFCNT_inc(nsv); /* Or it will be destroyed in FREETMPS */
409 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
419 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
420 MAGIC *mg, *moremagic;
422 if (SvTYPE(sv) >= SVt_PVMG) {
423 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
424 moremagic = mg->mg_moremagic;
425 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
426 MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
438 /* ... Magic cast/dispell .................................................. */
441 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
443 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
445 prevmagic->mg_moremagic = moremagic;
447 SvMAGIC_set(sv, moremagic);
449 mg->mg_moremagic = NULL;
450 Safefree(mg->mg_ptr);
453 #endif /* VMG_UVAR */
455 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
456 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
457 MAGIC *mg = NULL, *moremagic = NULL;
460 U32 oldgmg = SvGMAGICAL(sv);
464 if (SvTYPE(sv) >= SVt_PVMG) {
465 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
466 moremagic = mg->mg_moremagic;
467 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
468 MGWIZ *z = SV2MGWIZ(mg->mg_ptr);
469 if (z->sig == w->sig)
477 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
478 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
479 mg->mg_private = SIG_WIZ;
482 mg->mg_flags |= MGf_COPY;
483 #endif /* MGf_COPY */
486 mg->mg_flags |= MGf_DUP;
490 mg->mg_flags |= MGf_LOCAL;
491 #endif /* MGf_LOCAL */
493 if (SvTYPE(sv) < SVt_PVHV)
496 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
497 * magic is actually never called for them. If the GMAGICAL flag was off before
498 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
499 * now on, then this wizard has get magic. Hence we can work around the
500 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
501 * has uvar callbacks, it will be turned back on later. */
502 if (!oldgmg && SvGMAGICAL(sv))
510 uf[0].uf_val = vmg_svt_val;
517 /* One uvar magic in the chain is enough. */
518 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
519 moremagic = mg->mg_moremagic;
520 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
523 if (mg) { /* Found another uvar magic. */
524 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
525 if (olduf->uf_val == vmg_svt_val) {
526 /* It's our uvar magic, nothing to do. oldgmg was true. */
529 /* It's another uvar magic, backup it and replace it by ours. */
531 vmg_uvar_del(sv, prevmagic, mg, moremagic);
535 vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
536 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
537 * handled by our uvar callback. */
539 #endif /* VMG_UVAR */
545 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
546 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
549 #endif /* VMG_UVAR */
550 MAGIC *mg, *prevmagic, *moremagic = NULL;
552 if (SvTYPE(sv) < SVt_PVMG) { return 0; }
554 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
555 moremagic = mg->mg_moremagic;
556 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
557 MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
560 /* If the current has no uvar, short-circuit uvar deletion. */
561 uvars = w->uvar ? (uvars + 1) : 0;
562 #endif /* VMG_UVAR */
565 } else if (w->uvar) {
567 /* We can't break here since we need to find the ext magic to delete. */
568 #endif /* VMG_UVAR */
572 if (!mg) { return 0; }
575 prevmagic->mg_moremagic = moremagic;
577 SvMAGIC_set(sv, moremagic);
579 mg->mg_moremagic = NULL;
581 if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
582 SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
586 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
587 /* mg was the first ext magic in the chain that had uvar */
589 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
590 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_private == SIG_WIZ) {
591 MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
601 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
602 moremagic = mg->mg_moremagic;
603 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
606 uf = (struct ufuncs *) mg->mg_ptr;
607 /* assert(uf->uf_val == vmg_svt_val); */
608 if (uf[1].uf_val || uf[1].uf_set) {
609 /* Revert the original uvar magic. */
611 Renew(uf, 1, struct ufuncs);
612 mg->mg_ptr = (char *) uf;
613 mg->mg_len = sizeof(struct ufuncs);
615 /* Remove the uvar magic. */
616 vmg_uvar_del(sv, prevmagic, mg, moremagic);
620 #endif /* VMG_UVAR */
625 /* ... OP info ............................................................. */
627 #define VMG_OP_INFO_NAME 1
628 #define VMG_OP_INFO_OBJECT 2
630 STATIC U32 vmg_op_name_init = 0;
631 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
633 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
634 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
636 case VMG_OP_INFO_NAME:
637 if (!vmg_op_name_init) {
639 for (t = 0; t < OP_max; ++t)
640 vmg_op_name_len[t] = strlen(PL_op_name[t]);
641 vmg_op_name_init = 1;
644 case VMG_OP_INFO_OBJECT: {
646 if (!MY_CXT.b__op_stashes[0]) {
649 for (c = 0; c < OPc_MAX; ++c)
650 MY_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
659 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
660 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
665 case VMG_OP_INFO_NAME: {
666 OPCODE t = PL_op->op_type;
667 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
669 case VMG_OP_INFO_OBJECT: {
671 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
672 MY_CXT.b__op_stashes[vmg_opclass(PL_op)]);
681 /* ... svt callbacks ....................................................... */
683 #define VMG_CB_CALL_SET_RET(D) \
688 ret = SvOK(svr) ? SvIV(svr) : (D); \
692 #define VMG_CB_CALL_ARGS_MASK 15
693 #define VMG_CB_CALL_ARGS_SHIFT 4
694 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
696 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
699 unsigned int i, args, opinfo;
703 args = flags & VMG_CB_CALL_ARGS_MASK;
704 flags >>= VMG_CB_CALL_ARGS_SHIFT;
705 opinfo = flags & VMG_CB_CALL_OPINFO;
711 EXTEND(SP, args + 1);
712 PUSHs(sv_2mortal(newRV_inc(sv)));
714 for (i = 0; i < args; ++i) {
715 SV *sva = va_arg(ap, SV *);
716 PUSHs(sva ? sva : &PL_sv_undef);
720 XPUSHs(vmg_op_info(opinfo));
723 call_sv(cb, G_SCALAR);
725 VMG_CB_CALL_SET_RET(0);
733 #define vmg_cb_call1(I, F, S, A1) \
734 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
735 #define vmg_cb_call2(I, F, S, A1, A2) \
736 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
737 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
738 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
740 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
741 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
742 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
745 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
746 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
747 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
750 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
751 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
752 unsigned int opinfo = w->opinfo;
754 svtype t = SvTYPE(sv);
763 PUSHs(sv_2mortal(newRV_inc(sv)));
764 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
767 U8 *s = (U8 *) SvPV_const(sv, l);
769 len = utf8_length(s, s + l);
773 } else if (t == SVt_PVAV) {
774 len = av_len((AV *) sv) + 1;
781 XPUSHs(vmg_op_info(opinfo));
784 call_sv(w->cb_len, G_SCALAR);
786 VMG_CB_CALL_SET_RET(len);
791 return t == SVt_PVAV ? ret - 1 : ret;
794 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
795 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
796 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
799 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
801 unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
806 /* Don't even bother if we are in global destruction - the wizard is prisoner
807 * of circular references and we are way beyond user realm */
811 w = SV2MGWIZ(mg->mg_ptr);
813 /* So that it survives the temp cleanup below */
816 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
817 /* The previous magic tokens were freed but the magic chain wasn't updated, so
818 * if you access the sv from the callback the old deleted magics will trigger
819 * and cause memory misreads. Change 32686 solved it that way : */
828 PUSHs(sv_2mortal(newRV_inc(sv)));
829 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
831 XPUSHs(vmg_op_info(w->opinfo));
834 had_err = SvTRUE(ERRSV);
838 call_sv(w->cb_free, flags);
840 has_err = SvTRUE(ERRSV);
841 if (IN_PERL_COMPILETIME && !had_err && has_err)
844 VMG_CB_CALL_SET_RET(0);
850 /* Get the eval context that was pushed by call_sv, and fake an entry for the
851 * namesv, as die_where will need it to be non NULL later */
852 PERL_CONTEXT *cx = cxstack + cxstack_ix + 1;
853 if (!cx->blk_eval.old_namesv)
854 cx->blk_eval.old_namesv
855 = sv_2mortal(newSVpvn_share("Variable/Magic/DUMMY.pm", 23, 0));
858 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
859 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
862 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
863 * mg->mg_ptr reference count */
868 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
869 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
876 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
879 if (keylen == HEf_SVKEY) {
882 keysv = newSVpvn(key, keylen);
885 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
887 if (keylen != HEf_SVKEY) {
893 #endif /* MGf_COPY */
896 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
902 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
903 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
904 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
906 #endif /* MGf_LOCAL */
909 STATIC OP *vmg_pp_resetuvar(pTHX) {
910 SvRMAGICAL_on(cSVOP_sv);
914 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
917 SV *key = NULL, *newkey = NULL;
920 umg = mg_find(sv, PERL_MAGIC_uvar);
921 /* umg can't be NULL or we wouldn't be there. */
923 uf = (struct ufuncs *) umg->mg_ptr;
925 if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
926 if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
928 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
929 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
931 switch (mg->mg_type) {
934 case PERL_MAGIC_tied:
940 if (mg->mg_private != SIG_WIZ) continue;
941 w = SV2MGWIZ(mg->mg_ptr);
947 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
952 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
954 case HV_FETCH_ISSTORE:
955 case HV_FETCH_LVALUE:
956 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
958 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
960 case HV_FETCH_ISEXISTS:
962 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
966 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
971 if (SvRMAGICAL(sv) && !tied) {
972 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
973 * mistaken for a tied hash by the rest of hv_common. It will be reset by
974 * the op_ppaddr of a new fake op injected between the current and the next
977 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
979 NewOp(1101, svop, 1, SVOP);
980 svop->op_type = OP_STUB;
981 svop->op_ppaddr = vmg_pp_resetuvar;
982 svop->op_next = o->op_next;
985 o->op_next = (OP *) svop;
992 #endif /* VMG_UVAR */
994 /* ... Wizard destructor ................................................... */
996 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
1000 if (PL_dirty) /* During global destruction, the context is already freed */
1004 #if VMG_MULTIPLICITY
1005 if (w->owner != aTHX)
1008 #endif /* VMG_MULTIPLICITY */
1012 if (hv_delete(MY_CXT.wizards, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
1015 SvFLAGS(wiz) |= SVf_BREAK;
1018 if (w->cb_data != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
1019 if (w->cb_get != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
1020 if (w->cb_set != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
1021 if (w->cb_len != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
1022 if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
1023 if (w->cb_free != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
1025 if (w->cb_copy != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
1026 #endif /* MGf_COPY */
1028 if (w->cb_dup != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
1029 #endif /* MGf_DUP */
1031 if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
1032 #endif /* MGf_LOCAL */
1034 if (w->cb_fetch != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
1035 if (w->cb_store != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
1036 if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
1037 if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
1038 #endif /* VMG_UVAR */
1046 STATIC MGVTBL vmg_wizard_vtbl = {
1051 vmg_wizard_free, /* free */
1054 #endif /* MGf_COPY */
1057 #endif /* MGf_DUP */
1060 #endif /* MGf_LOCAL */
1063 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
1064 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
1069 } else if (SvNOK(sv)) {
1071 } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
1074 croak(vmg_invalid_sig);
1077 if (sig < SIG_MIN || sig > SIG_MAX)
1078 croak(vmg_invalid_sig);
1083 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
1084 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
1089 sig = SV2MGWIZ(SvRV(wiz))->sig;
1090 } else if (SvOK(wiz)) {
1091 sig = vmg_sv2sig(wiz);
1093 croak(vmg_invalid_wiz);
1098 if (!hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))
1099 croak(vmg_invalid_wiz);
1105 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
1106 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
1113 #if VMG_MULTIPLICITY
1114 if (SV2MGWIZ(wiz)->owner == aTHX)
1116 #endif /* VMG_MULTIPLICITY */
1117 sig = SV2MGWIZ(wiz)->sig;
1118 } else if (SvOK(wiz)) {
1119 sig = vmg_sv2sig(wiz);
1121 croak(vmg_invalid_wiz);
1126 return (old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))
1131 #define VMG_SET_CB(S, N) \
1133 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1135 #define VMG_SET_SVT_CB(S, N) \
1137 if (SvOK(cb) && SvROK(cb)) { \
1138 t->svt_ ## N = vmg_svt_ ## N; \
1139 w->cb_ ## N = newRV_inc(SvRV(cb)); \
1141 t->svt_ ## N = NULL; \
1142 w->cb_ ## N = NULL; \
1147 #define VMG_CLONE_CB(N) \
1148 z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
1152 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
1153 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
1158 Copy(w->vtbl, t, 1, MGVTBL);
1165 VMG_CLONE_CB(clear);
1169 #endif /* MGf_COPY */
1172 #endif /* MGf_DUP */
1174 VMG_CLONE_CB(local);
1175 #endif /* MGf_LOCAL */
1177 VMG_CLONE_CB(fetch);
1178 VMG_CLONE_CB(store);
1179 VMG_CLONE_CB(exists);
1180 VMG_CLONE_CB(delete);
1181 #endif /* VMG_UVAR */
1186 z->opinfo = w->opinfo;
1191 #endif /* VMG_THREADSAFE */
1193 /* --- XS ------------------------------------------------------------------ */
1195 MODULE = Variable::Magic PACKAGE = Variable::Magic
1203 MY_CXT.wizards = newHV();
1204 hv_iterinit(MY_CXT.wizards); /* Allocate iterator */
1205 MY_CXT.b__op_stashes[0] = NULL;
1206 stash = gv_stashpv(__PACKAGE__, 1);
1207 newCONSTSUB(stash, "SIG_MIN", newSVuv(SIG_MIN));
1208 newCONSTSUB(stash, "SIG_MAX", newSVuv(SIG_MAX));
1209 newCONSTSUB(stash, "SIG_NBR", newSVuv(SIG_NBR));
1210 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1211 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1212 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1213 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1214 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1215 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1216 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1217 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1218 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1219 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1220 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1221 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1222 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1223 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1224 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1225 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1235 U32 had_b__op_stash = 0;
1242 hv_iterinit(hv); /* Allocate iterator */
1243 hv_iterinit(MY_CXT.wizards);
1244 while ((key = hv_iternext(MY_CXT.wizards))) {
1246 char *sig = HePV(key, len);
1250 w = SV2MGWIZ(HeVAL(key));
1251 w = vmg_wizard_clone(w);
1253 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1254 mg->mg_private = SIG_WZO;
1256 if (!hv_store(hv, sig, len, sv, HeHASH(key))) croak("%s during CLONE", vmg_globstorefail);
1258 for (c = 0; c < OPc_MAX; ++c) {
1259 if (MY_CXT.b__op_stashes[c])
1260 had_b__op_stash |= (((U32) 1) << c);
1265 MY_CXT.wizards = hv;
1266 for (c = 0; c < OPc_MAX; ++c) {
1267 MY_CXT.b__op_stashes[c] = (had_b__op_stash & (((U32) 1) << c))
1268 ? gv_stashpv(vmg_opclassnames[c], 1) : NULL;
1272 #endif /* VMG_THREADSAFE */
1292 #endif /* MGf_COPY */
1295 #endif /* MGf_DUP */
1298 #endif /* MGf_LOCAL */
1301 #endif /* VMG_UVAR */
1302 ) { croak(vmg_wrongargnum); }
1307 sig = vmg_sv2sig(svsig);
1308 if ((old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))) {
1309 ST(0) = sv_2mortal(newRV_inc(*old));
1319 VMG_SET_CB(ST(i++), data);
1321 w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1323 vmg_op_info_init(w->opinfo);
1324 VMG_SET_SVT_CB(ST(i++), get);
1325 VMG_SET_SVT_CB(ST(i++), set);
1326 VMG_SET_SVT_CB(ST(i++), len);
1327 VMG_SET_SVT_CB(ST(i++), clear);
1328 VMG_SET_SVT_CB(ST(i++), free);
1330 VMG_SET_SVT_CB(ST(i++), copy);
1331 #endif /* MGf_COPY */
1333 /* VMG_SET_SVT_CB(ST(i++), dup); */
1337 #endif /* MGf_DUP */
1339 VMG_SET_SVT_CB(ST(i++), local);
1340 #endif /* MGf_LOCAL */
1342 VMG_SET_CB(ST(i++), fetch);
1343 VMG_SET_CB(ST(i++), store);
1344 VMG_SET_CB(ST(i++), exists);
1345 VMG_SET_CB(ST(i++), delete);
1347 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1348 w->uvar = SvTRUE(cb) ? 2 : 1;
1351 #endif /* VMG_UVAR */
1352 #if VMG_MULTIPLICITY
1354 #endif /* VMG_MULTIPLICITY */
1359 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1360 mg->mg_private = SIG_WZO;
1363 if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), sv, 0)) croak(vmg_globstorefail);
1365 RETVAL = newRV_noinc(sv);
1372 RETVAL = newSVuv(vmg_gensig());
1379 if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1380 RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1384 SV *cast(SV *sv, SV *wiz, ...)
1385 PROTOTYPE: \[$@%&*]$@
1390 wiz = vmg_wizard_wiz(wiz);
1396 av_fill(args, items - 2);
1397 for (i = 2; i < items; ++i) {
1400 if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1403 ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1410 getdata(SV *sv, SV *wiz)
1411 PROTOTYPE: \[$@%&*]$
1416 sig = vmg_wizard_sig(wiz);
1417 data = vmg_data_get(SvRV(sv), sig);
1418 if (!data) { XSRETURN_UNDEF; }
1422 SV *dispell(SV *sv, SV *wiz)
1423 PROTOTYPE: \[$@%&*]$
1427 sig = vmg_wizard_sig(wiz);
1428 RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));