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 /* --- XS helpers ---------------------------------------------------------- */
15 #define XSH_PACKAGE "Variable::Magic"
20 /* ... Features ............................................................ */
22 /* uvar magic and Hash::Util::FieldHash were commited with 28419, but we only
23 * enable them on 5.10 */
24 #if XSH_HAS_PERL(5, 10, 0)
30 #if XSH_HAS_PERL_MAINT(5, 11, 0, 32969) || XSH_HAS_PERL(5, 12, 0)
31 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
33 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
36 #if XSH_HAS_PERL(5, 17, 4)
37 # define VMG_COMPAT_SCALAR_NOLEN 1
39 # define VMG_COMPAT_SCALAR_NOLEN 0
42 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160, partially
43 * reverted to dev-5.11 as 9cdcb38b */
44 #if XSH_HAS_PERL_MAINT(5, 8, 9, 28160) || XSH_HAS_PERL_MAINT(5, 9, 3, 25854) || XSH_HAS_PERL(5, 10, 0)
45 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
46 # if XSH_HAS_PERL(5, 11, 0)
47 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
49 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
52 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
53 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 1
56 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
57 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
59 # ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
60 # define VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID 0
64 /* Applied to dev-5.11 as 34908 */
65 #if XSH_HAS_PERL_MAINT(5, 11, 0, 34908) || XSH_HAS_PERL(5, 12, 0)
66 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
68 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
71 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
72 #if XSH_HAS_PERL_MAINT(5, 8, 9, 32542) || XSH_HAS_PERL_MAINT(5, 9, 5, 31473) || XSH_HAS_PERL(5, 10, 0)
73 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
75 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
78 #if XSH_HAS_PERL(5, 11, 0)
79 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 1
81 # define VMG_COMPAT_HASH_DELETE_NOUVAR_VOID 0
84 #if XSH_HAS_PERL(5, 17, 0)
85 # define VMG_COMPAT_CODE_COPY_CLONE 1
87 # define VMG_COMPAT_CODE_COPY_CLONE 0
90 #if XSH_HAS_PERL(5, 13, 2)
91 # define VMG_COMPAT_GLOB_GET 1
93 # define VMG_COMPAT_GLOB_GET 0
96 /* ... Trampoline ops ...................................................... */
98 #define VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE (XSH_HAS_PERL(5, 10, 0) && !XSH_HAS_PERL(5, 10, 1))
100 /* NewOp() isn't public in perl 5.8.0. */
101 #define VMG_RESET_RMG_NEEDS_TRAMPOLINE (VMG_UVAR && (XSH_THREADSAFE || !XSH_HAS_PERL(5, 8, 1)))
103 #define VMG_NEEDS_TRAMPOLINE VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE || VMG_RESET_RMG_NEEDS_TRAMPOLINE
105 #if VMG_NEEDS_TRAMPOLINE
112 static void vmg_trampoline_init(vmg_trampoline *t, OP *(*cb)(pTHX)) {
113 t->temp.op_type = OP_STUB;
114 t->temp.op_ppaddr = 0;
115 t->temp.op_next = (OP *) &t->target;
116 t->temp.op_flags = 0;
117 t->temp.op_private = 0;
119 t->target.op_type = OP_STUB;
120 t->target.op_ppaddr = cb;
121 t->target.op_next = NULL;
122 t->target.op_flags = 0;
123 t->target.op_private = 0;
124 t->target.op_sv = NULL;
127 static OP *vmg_trampoline_bump(pTHX_ vmg_trampoline *t, SV *sv, OP *o) {
128 #define vmg_trampoline_bump(T, S, O) vmg_trampoline_bump(aTHX_ (T), (S), (O))
130 t->temp.op_next = (OP *) &t->target;
132 t->target.op_sv = sv;
133 t->target.op_next = o->op_next;
138 #endif /* VMG_NEEDS_TRAMPOLINE */
140 /* --- Compatibility ------------------------------------------------------- */
143 # define Newx(v, n, c) New(0, v, n, c)
147 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
151 # define SvRV_const(sv) SvRV((SV *) sv)
154 #ifndef SvREFCNT_inc_simple_void
155 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
158 #ifndef SvREFCNT_dec_NN
159 # define SvREFCNT_dec_NN(sv) ((void) SvREFCNT_dec(sv))
163 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
166 #ifndef PERL_MAGIC_ext
167 # define PERL_MAGIC_ext '~'
170 #ifndef PERL_MAGIC_tied
171 # define PERL_MAGIC_tied 'P'
178 #ifndef IN_PERL_COMPILETIME
179 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
183 # define OP_NAME(O) (PL_op_name[(O)->op_type])
187 # define OP_CLASS(O) (PL_opargs[(O)->op_type] & OA_CLASS_MASK)
190 #define VMG_CAREFUL_SELF_DESTRUCTION XSH_HAS_PERL(5, 25, 3)
192 /* ... Bug-free mg_magical ................................................. */
194 /* See the discussion at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
196 #if XSH_HAS_PERL(5, 11, 3)
198 #define vmg_mg_magical(S) mg_magical(S)
202 static void vmg_mg_magical(SV *sv) {
206 if ((mg = SvMAGIC(sv))) {
208 const MGVTBL* const vtbl = mg->mg_virtual;
210 if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
217 } while ((mg = mg->mg_moremagic));
218 if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
225 /* ... Cleaner version of sv_magicext() .................................... */
227 static MAGIC *vmg_sv_magicext(pTHX_ SV *sv, SV *obj, const MGVTBL *vtbl, const void *ptr, I32 len) {
228 #define vmg_sv_magicext(S, O, V, P, L) vmg_sv_magicext(aTHX_ (S), (O), (V), (P), (L))
231 mg = sv_magicext(sv, obj, PERL_MAGIC_ext, vtbl, ptr, len);
238 mg->mg_flags |= MGf_COPY;
241 mg->mg_flags |= MGf_DUP;
245 mg->mg_flags |= MGf_LOCAL;
246 #endif /* MGf_LOCAL */
248 if (mg->mg_flags & MGf_REFCOUNTED)
254 /* ... Safe version of call_sv() ........................................... */
256 static I32 vmg_call_sv(pTHX_ SV *sv, I32 flags, int (*cleanup)(pTHX_ void *), void *ud) {
257 #define vmg_call_sv(S, F, C, U) vmg_call_sv(aTHX_ (S), (F), (C), (U))
262 old_err = newSVsv(ERRSV);
263 sv_setsv(ERRSV, &PL_sv_undef);
266 ret = call_sv(sv, flags | G_EVAL);
269 SvREFCNT_dec(old_err);
271 if (IN_PERL_COMPILETIME) {
274 sv_catsv(PL_errors, ERRSV);
276 Perl_warn(aTHX_ "%s", SvPV_nolen(ERRSV));
279 #if XSH_HAS_PERL(5, 10, 0) || defined(PL_parser)
281 ++PL_parser->error_count;
282 #elif defined(PL_error_count)
288 if (!cleanup || cleanup(aTHX_ ud))
293 sv_setsv(ERRSV, old_err);
294 SvREFCNT_dec(old_err);
301 /* --- Stolen chunk of B --------------------------------------------------- */
316 #if XSH_HAS_PERL(5, 21, 5)
319 #if XSH_HAS_PERL(5, 21, 7)
325 static const char *const vmg_opclassnames[] = {
338 #if XSH_HAS_PERL(5, 21, 5)
341 #if XSH_HAS_PERL(5, 21, 7)
347 static opclass vmg_opclass(pTHX_ const OP *o) {
348 #define vmg_opclass(O) vmg_opclass(aTHX_ (O))
354 if (o->op_type == 0) {
355 #if XSH_HAS_PERL(5, 21, 7)
356 if (o->op_targ == OP_NEXTSTATE || o->op_targ == OP_DBSTATE)
359 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
362 if (o->op_type == OP_SASSIGN)
363 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
365 if (o->op_type == OP_AELEMFAST) {
366 #if PERL_VERSION <= 14
367 if (o->op_flags & OPf_SPECIAL)
379 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_RCATLINE)
383 switch (OP_CLASS(o)) {
400 case OA_PVOP_OR_SVOP:
402 #if XSH_HAS_PERL(5, 13, 7)
403 (o->op_type != OP_CUSTOM) &&
405 (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF)))
406 #if defined(USE_ITHREADS) && XSH_HAS_PERL(5, 8, 9)
407 ? OPc_PADOP : OPc_PVOP;
409 ? OPc_SVOP : OPc_PVOP;
415 case OA_BASEOP_OR_UNOP:
416 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
418 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
420 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
422 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
425 if (o->op_flags & OPf_STACKED)
427 else if (o->op_flags & OPf_SPECIAL)
431 #if XSH_HAS_PERL(5, 21, 5)
435 #if XSH_HAS_PERL(5, 21, 7)
444 /* --- Error messages ------------------------------------------------------ */
446 static const char vmg_invalid_wiz[] = "Invalid wizard object";
447 static const char vmg_wrongargnum[] = "Wrong number of arguments";
449 /* --- Thread-local storage ------------------------------------------------ */
452 HV *b__op_stashes[OPc_MAX];
455 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
456 vmg_trampoline propagate_errsv;
458 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
459 vmg_trampoline reset_rmg;
465 static void xsh_user_clone(pTHX_ const xsh_user_cxt_t *old_cxt, xsh_user_cxt_t *new_cxt) {
468 for (c = OPc_NULL; c < OPc_MAX; ++c) {
469 new_cxt->b__op_stashes[c] = old_cxt->b__op_stashes[c]
470 ? gv_stashpv(vmg_opclassnames[c], 1)
474 new_cxt->depth = old_cxt->depth;
475 new_cxt->freed_tokens = NULL;
481 #endif /* XSH_THREADSAFE */
483 #define XSH_THREADS_NEED_TEARDOWN_LATE 1
485 #include "xsh/threads.h"
487 /* --- <vmg_vtable> structure ---------------------------------------------- */
496 static vmg_vtable *vmg_vtable_alloc(pTHX) {
497 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
500 t = VOID2(vmg_vtable *, PerlMemShared_malloc(sizeof *t));
502 t->vtbl = VOID2(MGVTBL *, PerlMemShared_malloc(sizeof *t->vtbl));
508 #define vmg_vtable_vtbl(T) (T)->vtbl
510 static perl_mutex vmg_vtable_refcount_mutex;
512 static vmg_vtable *vmg_vtable_dup(pTHX_ vmg_vtable *t) {
513 #define vmg_vtable_dup(T) vmg_vtable_dup(aTHX_ (T))
514 XSH_LOCK(&vmg_vtable_refcount_mutex);
516 XSH_UNLOCK(&vmg_vtable_refcount_mutex);
521 static void vmg_vtable_free(pTHX_ vmg_vtable *t) {
522 #define vmg_vtable_free(T) vmg_vtable_free(aTHX_ (T))
525 XSH_LOCK(&vmg_vtable_refcount_mutex);
526 refcount = --t->refcount;
527 XSH_UNLOCK(&vmg_vtable_refcount_mutex);
530 PerlMemShared_free(t->vtbl);
531 PerlMemShared_free(t);
535 #else /* XSH_THREADSAFE */
537 typedef MGVTBL vmg_vtable;
539 static vmg_vtable *vmg_vtable_alloc(pTHX) {
540 #define vmg_vtable_alloc() vmg_vtable_alloc(aTHX)
543 Newx(t, 1, vmg_vtable);
548 #define vmg_vtable_vtbl(T) ((MGVTBL *) (T))
550 #define vmg_vtable_free(T) Safefree(T)
552 #endif /* !XSH_THREADSAFE */
554 /* --- <vmg_wizard> structure ---------------------------------------------- */
563 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
568 #endif /* MGf_LOCAL */
570 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
571 #endif /* VMG_UVAR */
574 static void vmg_op_info_init(pTHX_ unsigned int opinfo);
576 static vmg_wizard *vmg_wizard_alloc(pTHX_ UV opinfo) {
577 #define vmg_wizard_alloc(O) vmg_wizard_alloc(aTHX_ (O))
580 Newx(w, 1, vmg_wizard);
583 w->opinfo = (U8) ((opinfo < 255) ? opinfo : 255);
585 vmg_op_info_init(aTHX_ w->opinfo);
587 w->vtable = vmg_vtable_alloc();
592 static void vmg_wizard_free(pTHX_ vmg_wizard *w) {
593 #define vmg_wizard_free(W) vmg_wizard_free(aTHX_ (W))
597 /* During global destruction, any of the callbacks may already have been
598 * freed, so we can't rely on still being able to access them. */
600 SvREFCNT_dec(w->cb_data);
601 SvREFCNT_dec(w->cb_get);
602 SvREFCNT_dec(w->cb_set);
603 SvREFCNT_dec(w->cb_len);
604 SvREFCNT_dec(w->cb_clear);
605 SvREFCNT_dec(w->cb_free);
606 SvREFCNT_dec(w->cb_copy);
608 SvREFCNT_dec(w->cb_dup);
611 SvREFCNT_dec(w->cb_local);
612 #endif /* MGf_LOCAL */
614 SvREFCNT_dec(w->cb_fetch);
615 SvREFCNT_dec(w->cb_store);
616 SvREFCNT_dec(w->cb_exists);
617 SvREFCNT_dec(w->cb_delete);
618 #endif /* VMG_UVAR */
621 /* PerlMemShared_free() and Safefree() are still fine during global
622 * destruction though. */
623 vmg_vtable_free(w->vtable);
631 #define VMG_CLONE_CB(N) \
632 z->cb_ ## N = (w->cb_ ## N) ? SvREFCNT_inc(sv_dup(w->cb_ ## N, params)) \
635 static const vmg_wizard *vmg_wizard_dup(pTHX_ const vmg_wizard *w, CLONE_PARAMS *params) {
636 #define vmg_wizard_dup(W, P) vmg_wizard_dup(aTHX_ (W), (P))
642 Newx(z, 1, vmg_wizard);
644 z->vtable = vmg_vtable_dup(w->vtable);
646 z->opinfo = w->opinfo;
658 #endif /* MGf_LOCAL */
662 VMG_CLONE_CB(exists);
663 VMG_CLONE_CB(delete);
664 #endif /* VMG_UVAR */
669 #endif /* XSH_THREADSAFE */
671 #define vmg_wizard_id(W) PTR2IV(vmg_vtable_vtbl((W)->vtable))
673 /* --- Wizard SV objects --------------------------------------------------- */
675 static int vmg_wizard_sv_free(pTHX_ SV *sv, MAGIC *mg) {
676 vmg_wizard_free((vmg_wizard *) mg->mg_ptr);
683 static int vmg_wizard_sv_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
684 mg->mg_ptr = (char *) vmg_wizard_dup((const vmg_wizard *) mg->mg_ptr, params);
689 #endif /* XSH_THREADSAFE */
691 static MGVTBL vmg_wizard_sv_vtbl = {
696 vmg_wizard_sv_free, /* free */
699 vmg_wizard_sv_dup, /* dup */
705 #endif /* MGf_LOCAL */
708 static SV *vmg_wizard_sv_new(pTHX_ const vmg_wizard *w) {
709 #define vmg_wizard_sv_new(W) vmg_wizard_sv_new(aTHX_ (W))
715 wiz = newSViv(PTR2IV(w));
718 vmg_sv_magicext(wiz, NULL, &vmg_wizard_sv_vtbl, w, 0);
727 #define vmg_sv_has_wizard_type(S) (SvTYPE(S) >= SVt_PVMG)
729 static const vmg_wizard *vmg_wizard_from_sv_nocheck(const SV *wiz) {
732 for (mg = SvMAGIC(wiz); mg; mg = mg->mg_moremagic) {
733 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_virtual == &vmg_wizard_sv_vtbl)
734 return (const vmg_wizard *) mg->mg_ptr;
740 #else /* XSH_THREADSAFE */
742 #define vmg_sv_has_wizard_type(S) SvIOK(S)
744 #define vmg_wizard_from_sv_nocheck(W) INT2PTR(const vmg_wizard *, SvIVX(W))
746 #endif /* !XSH_THREADSAFE */
748 #define vmg_wizard_from_sv(W) (vmg_sv_has_wizard_type(W) ? vmg_wizard_from_sv_nocheck(W) : NULL)
750 static const vmg_wizard *vmg_wizard_from_mg(const MAGIC *mg) {
751 if (mg->mg_type == PERL_MAGIC_ext && mg->mg_len == HEf_SVKEY) {
752 SV *sv = (SV *) mg->mg_ptr;
754 if (vmg_sv_has_wizard_type(sv))
755 return vmg_wizard_from_sv_nocheck(sv);
761 #define vmg_wizard_from_mg_nocheck(M) vmg_wizard_from_sv_nocheck((const SV *) (M)->mg_ptr)
763 /* --- User-level functions implementation --------------------------------- */
765 static const MAGIC *vmg_find(const SV *sv, const vmg_wizard *w) {
769 if (SvTYPE(sv) < SVt_PVMG)
772 wid = vmg_wizard_id(w);
774 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
775 const vmg_wizard *z = vmg_wizard_from_mg(mg);
777 if (z && vmg_wizard_id(z) == wid)
784 /* ... Construct private data .............................................. */
786 static SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, SV **args, I32 items) {
787 #define vmg_data_new(C, S, A, I) vmg_data_new(aTHX_ (C), (S), (A), (I))
796 PUSHSTACKi(PERLSI_MAGIC);
799 EXTEND(SP, items + 1);
800 PUSHs(sv_2mortal(newRV_inc(sv)));
801 for (i = 0; i < items; ++i)
805 vmg_call_sv(ctor, G_SCALAR, 0, NULL);
809 #if XSH_HAS_PERL(5, 8, 3)
810 SvREFCNT_inc_simple_void(nsv); /* Or it will be destroyed in FREETMPS */
812 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
824 static SV *vmg_data_get(pTHX_ SV *sv, const vmg_wizard *w) {
825 #define vmg_data_get(S, W) vmg_data_get(aTHX_ (S), (W))
826 const MAGIC *mg = vmg_find(sv, w);
828 return mg ? mg->mg_obj : NULL;
831 /* ... Magic cast/dispell .................................................. */
835 static I32 vmg_svt_val(pTHX_ IV, SV *);
838 struct ufuncs new_uf;
839 struct ufuncs old_uf;
842 #endif /* VMG_UVAR */
844 static void vmg_mg_del(pTHX_ SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
845 #define vmg_mg_del(S, P, M, N) vmg_mg_del(aTHX_ (S), (P), (M), (N))
849 prevmagic->mg_moremagic = moremagic;
851 SvMAGIC_set(sv, moremagic);
853 /* Destroy private data */
855 if (mg->mg_type == PERL_MAGIC_uvar) {
856 Safefree(mg->mg_ptr);
858 #endif /* VMG_UVAR */
859 if (mg->mg_obj != sv) {
860 SvREFCNT_dec(mg->mg_obj);
863 /* Unreference the wizard */
864 SvREFCNT_dec((SV *) mg->mg_ptr);
868 #endif /* VMG_UVAR */
871 mg->mg_moremagic = XSH_CXT.freed_tokens;
872 XSH_CXT.freed_tokens = mg;
874 mg->mg_moremagic = NULL;
879 static int vmg_magic_chain_free(pTHX_ MAGIC *mg, MAGIC *skip) {
880 #define vmg_magic_chain_free(M, S) vmg_magic_chain_free(aTHX_ (M), (S))
884 MAGIC *moremagic = mg->mg_moremagic;
897 static UV vmg_cast(pTHX_ SV *sv, const vmg_wizard *w, const SV *wiz, SV **args, I32 items) {
898 #define vmg_cast(S, W, WIZ, A, I) vmg_cast(aTHX_ (S), (W), (WIZ), (A), (I))
907 oldgmg = SvGMAGICAL(sv);
909 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args, items) : NULL;
911 t = vmg_vtable_vtbl(w->vtable);
912 mg = vmg_sv_magicext(sv, data, t, wiz, HEf_SVKEY);
914 if (SvTYPE(sv) < SVt_PVHV)
917 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
918 * magic is actually never called for them. If the GMAGICAL flag was off before
919 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
920 * now on, then this wizard has get magic. Hence we can work around the
921 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
922 * has uvar callbacks, it will be turned back on later. */
923 if (!oldgmg && SvGMAGICAL(sv))
928 MAGIC *prevmagic, *moremagic = NULL;
931 ud.new_uf.uf_val = vmg_svt_val;
932 ud.new_uf.uf_set = NULL;
933 ud.new_uf.uf_index = 0;
934 ud.old_uf.uf_val = NULL;
935 ud.old_uf.uf_set = NULL;
936 ud.old_uf.uf_index = 0;
938 /* One uvar magic in the chain is enough. */
939 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
940 moremagic = mg->mg_moremagic;
941 if (mg->mg_type == PERL_MAGIC_uvar)
945 if (mg) { /* Found another uvar magic. */
946 struct ufuncs *uf = (struct ufuncs *) mg->mg_ptr;
947 if (uf->uf_val == vmg_svt_val) {
948 /* It's our uvar magic, nothing to do. oldgmg was true. */
951 /* It's another uvar magic, backup it and replace it by ours. */
953 vmg_mg_del(sv, prevmagic, mg, moremagic);
957 sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &ud, sizeof(ud));
959 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
960 * handled by our uvar callback. */
962 #endif /* VMG_UVAR */
968 static UV vmg_dispell(pTHX_ SV *sv, const vmg_wizard *w) {
969 #define vmg_dispell(S, W) vmg_dispell(aTHX_ (S), (W))
972 #endif /* VMG_UVAR */
973 MAGIC *mg, *prevmagic, *moremagic = NULL;
974 IV wid = vmg_wizard_id(w);
976 if (SvTYPE(sv) < SVt_PVMG)
979 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
982 moremagic = mg->mg_moremagic;
984 z = vmg_wizard_from_mg(mg);
986 IV zid = vmg_wizard_id(z);
990 /* If the current has no uvar, short-circuit uvar deletion. */
991 uvars = z->uvar ? (uvars + 1) : 0;
993 } else if (z->uvar) {
995 /* We can't break here since we need to find the ext magic to delete. */
1000 #endif /* !VMG_UVAR */
1006 vmg_mg_del(sv, prevmagic, mg, moremagic);
1009 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
1010 /* mg was the first ext magic in the chain that had uvar */
1012 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
1013 const vmg_wizard *z = vmg_wizard_from_mg(mg);
1024 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
1025 moremagic = mg->mg_moremagic;
1026 if (mg->mg_type == PERL_MAGIC_uvar)
1030 ud = (vmg_uvar_ud *) mg->mg_ptr;
1031 if (ud->old_uf.uf_val || ud->old_uf.uf_set) {
1032 /* Revert the original uvar magic. */
1034 Newx(uf, 1, struct ufuncs);
1037 mg->mg_ptr = (char *) uf;
1038 mg->mg_len = sizeof(*uf);
1040 /* Remove the uvar magic. */
1041 vmg_mg_del(sv, prevmagic, mg, moremagic);
1045 #endif /* VMG_UVAR */
1052 /* ... OP info ............................................................. */
1054 #define VMG_OP_INFO_NAME 1
1055 #define VMG_OP_INFO_OBJECT 2
1058 static perl_mutex vmg_op_name_init_mutex;
1061 static U32 vmg_op_name_init = 0;
1062 static unsigned char vmg_op_name_len[MAXO] = { 0 };
1064 static void vmg_op_info_init(pTHX_ unsigned int opinfo) {
1065 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
1067 case VMG_OP_INFO_NAME:
1068 XSH_LOCK(&vmg_op_name_init_mutex);
1069 if (!vmg_op_name_init) {
1071 for (t = 0; t < OP_max; ++t)
1072 vmg_op_name_len[t] = strlen(PL_op_name[t]);
1073 vmg_op_name_init = 1;
1075 XSH_UNLOCK(&vmg_op_name_init_mutex);
1077 case VMG_OP_INFO_OBJECT: {
1079 if (!XSH_CXT.b__op_stashes[0]) {
1082 for (c = OPc_NULL; c < OPc_MAX; ++c)
1083 XSH_CXT.b__op_stashes[c] = gv_stashpv(vmg_opclassnames[c], 1);
1092 static SV *vmg_op_info(pTHX_ unsigned int opinfo) {
1093 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
1095 return &PL_sv_undef;
1098 case VMG_OP_INFO_NAME: {
1101 OPCODE t = PL_op->op_type;
1102 name = OP_NAME(PL_op);
1103 name_len = (t == OP_CUSTOM) ? strlen(name) : vmg_op_name_len[t];
1104 return sv_2mortal(newSVpvn(name, name_len));
1106 case VMG_OP_INFO_OBJECT: {
1108 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
1109 XSH_CXT.b__op_stashes[vmg_opclass(PL_op)]);
1115 return &PL_sv_undef;
1118 /* --- svt callbacks ------------------------------------------------------- */
1120 #define VMG_CB_CALL_ARGS_MASK 15
1121 #define VMG_CB_CALL_ARGS_SHIFT 4
1122 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT) /* 1|2 */
1123 #define VMG_CB_CALL_GUARD 4
1125 static int vmg_dispell_guard_oncroak(pTHX_ void *ud) {
1130 /* If we're at the upmost magic call and we're about to die, we can just free
1131 * the tokens right now, since we will jump past the problematic part of our
1133 if (XSH_CXT.depth == 0 && XSH_CXT.freed_tokens) {
1134 vmg_magic_chain_free(XSH_CXT.freed_tokens, NULL);
1135 XSH_CXT.freed_tokens = NULL;
1141 static int vmg_dispell_guard_free(pTHX_ SV *sv, MAGIC *mg) {
1142 vmg_magic_chain_free((MAGIC *) mg->mg_ptr, NULL);
1149 static int vmg_dispell_guard_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *params) {
1150 /* The freed magic tokens aren't cloned by perl because it cannot reach them
1151 * (they have been detached from their parent SV when they were enqueued).
1152 * Hence there's nothing to purge in the new thread. */
1158 #endif /* XSH_THREADSAFE */
1160 static MGVTBL vmg_dispell_guard_vtbl = {
1165 vmg_dispell_guard_free, /* free */
1168 vmg_dispell_guard_dup, /* dup */
1174 #endif /* MGf_LOCAL */
1177 static SV *vmg_dispell_guard_new(pTHX_ MAGIC *root) {
1178 #define vmg_dispell_guard_new(R) vmg_dispell_guard_new(aTHX_ (R))
1181 guard = sv_newmortal();
1182 vmg_sv_magicext(guard, NULL, &vmg_dispell_guard_vtbl, root, 0);
1187 static int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
1190 unsigned int i, args, opinfo;
1191 MAGIC **chain = NULL;
1196 args = flags & VMG_CB_CALL_ARGS_MASK;
1197 flags >>= VMG_CB_CALL_ARGS_SHIFT;
1198 opinfo = flags & VMG_CB_CALL_OPINFO;
1203 PUSHSTACKi(PERLSI_MAGIC);
1206 EXTEND(SP, args + 1);
1207 PUSHs(sv_2mortal(newRV_inc(sv)));
1209 for (i = 0; i < args; ++i) {
1210 SV *sva = va_arg(ap, SV *);
1211 PUSHs(sva ? sva : &PL_sv_undef);
1215 XPUSHs(vmg_op_info(opinfo));
1218 if (flags & VMG_CB_CALL_GUARD) {
1221 vmg_call_sv(cb, G_SCALAR, vmg_dispell_guard_oncroak, NULL);
1223 if (XSH_CXT.depth == 0 && XSH_CXT.freed_tokens)
1224 chain = &XSH_CXT.freed_tokens;
1226 vmg_call_sv(cb, G_SCALAR, 0, NULL);
1232 ret = (int) SvIV(svr);
1244 if (svr && !SvTEMP(svr))
1248 vmg_dispell_guard_new(*chain);
1255 #define VMG_CB_FLAGS(OI, A) \
1256 ((((unsigned int) (OI)) << VMG_CB_CALL_ARGS_SHIFT) | (A))
1258 #define vmg_cb_call1(I, OI, S, A1) \
1259 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 1), (S), (A1))
1260 #define vmg_cb_call2(I, OI, S, A1, A2) \
1261 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 2), (S), (A1), (A2))
1262 #define vmg_cb_call3(I, OI, S, A1, A2, A3) \
1263 vmg_cb_call(aTHX_ (I), VMG_CB_FLAGS((OI), 3), (S), (A1), (A2), (A3))
1265 /* ... Default no-op magic callback ........................................ */
1267 static int vmg_svt_default_noop(pTHX_ SV *sv, MAGIC *mg) {
1271 /* ... get magic ........................................................... */
1273 static int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
1274 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1276 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
1279 #define vmg_svt_get_noop vmg_svt_default_noop
1281 /* ... set magic ........................................................... */
1283 static int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
1284 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1286 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
1289 #define vmg_svt_set_noop vmg_svt_default_noop
1291 /* ... len magic ........................................................... */
1293 static U32 vmg_sv_len(pTHX_ SV *sv) {
1294 #define vmg_sv_len(S) vmg_sv_len(aTHX_ (S))
1296 #if XSH_HAS_PERL(5, 9, 3)
1297 const U8 *s = VOID2(const U8 *, VOID2(const void *, SvPV_const(sv, len)));
1299 U8 *s = SvPV(sv, len);
1302 return DO_UTF8(sv) ? utf8_length(s, s + len) : len;
1305 static U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
1306 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1307 unsigned int opinfo = w->opinfo;
1310 svtype t = SvTYPE(sv);
1317 PUSHSTACKi(PERLSI_MAGIC);
1321 PUSHs(sv_2mortal(newRV_inc(sv)));
1322 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1324 len = vmg_sv_len(sv);
1326 } else if (t == SVt_PVAV) {
1327 len = av_len((AV *) sv) + 1;
1331 PUSHs(&PL_sv_undef);
1334 XPUSHs(vmg_op_info(opinfo));
1337 vmg_call_sv(w->cb_len, G_SCALAR, 0, NULL);
1341 ret = SvOK(svr) ? (U32) SvUV(svr) : len;
1354 static U32 vmg_svt_len_noop(pTHX_ SV *sv, MAGIC *mg) {
1356 svtype t = SvTYPE(sv);
1359 len = vmg_sv_len(sv);
1360 } else if (t == SVt_PVAV) {
1361 len = (U32) av_len((AV *) sv);
1367 /* ... clear magic ......................................................... */
1369 static int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
1370 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1371 unsigned int flags = w->opinfo;
1373 #if !XSH_HAS_PERL(5, 12, 0)
1374 flags |= VMG_CB_CALL_GUARD;
1377 return vmg_cb_call1(w->cb_clear, flags, sv, mg->mg_obj);
1380 #define vmg_svt_clear_noop vmg_svt_default_noop
1382 /* ... free magic .......................................................... */
1384 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1386 static OP *vmg_pp_propagate_errsv(pTHX) {
1387 SVOP *o = cSVOPx(PL_op);
1390 sv_setsv(ERRSV, o->op_sv);
1391 SvREFCNT_dec(o->op_sv);
1398 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1400 static int vmg_propagate_errsv_free(pTHX_ SV *sv, MAGIC *mg) {
1402 sv_setsv(ERRSV, mg->mg_obj);
1407 /* perl is already kind enough to handle the cloning of the mg_obj member,
1408 hence we don't need to define a dup magic callback. */
1410 static MGVTBL vmg_propagate_errsv_vtbl = {
1415 vmg_propagate_errsv_free, /* free */
1420 #endif /* MGf_LOCAL */
1425 #if VMG_CAREFUL_SELF_DESTRUCTION
1426 SV *rsv; /* The ref to the sv currently being freed, pushed on the stack */
1430 } vmg_svt_free_cleanup_ud;
1432 static int vmg_svt_free_cleanup(pTHX_ void *ud_) {
1433 vmg_svt_free_cleanup_ud *ud = VOID2(vmg_svt_free_cleanup_ud *, ud_);
1436 U32 optype = PL_op ? PL_op->op_type : OP_NULL;
1438 if (optype == OP_LEAVETRY || optype == OP_LEAVEEVAL) {
1439 SV *errsv = newSVsv(ERRSV);
1442 LEAVE_SCOPE(ud->base);
1444 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1445 if (optype == OP_LEAVETRY) {
1447 PL_op = vmg_trampoline_bump(&XSH_CXT.propagate_errsv, errsv, PL_op);
1448 } else if (optype == OP_LEAVEEVAL) {
1449 SV *guard = sv_newmortal();
1450 vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1452 #else /* !VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1453 # if !XSH_HAS_PERL(5, 8, 9)
1455 SV *guard = sv_newmortal();
1456 vmg_sv_magicext(guard, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1459 vmg_sv_magicext(ERRSV, errsv, &vmg_propagate_errsv_vtbl, NULL, 0);
1461 #endif /* VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE */
1466 /* Don't propagate */
1472 #if VMG_CAREFUL_SELF_DESTRUCTION
1473 /* Silently undo the ref - don't trigger destruction in the referent
1474 * for a second time */
1475 if (SvROK(ud->rsv) && SvRV(ud->rsv) == sv) {
1476 SvRV_set(ud->rsv, NULL);
1478 --SvREFCNT(sv); /* Silent */
1480 SvREFCNT_dec_NN(ud->rsv);
1483 /* We are about to croak() while sv is being destroyed. Try to clean up
1487 vmg_mg_del(sv, NULL, mg, mg->mg_moremagic);
1490 SvREFCNT_dec(sv); /* Re-trigger destruction */
1492 vmg_dispell_guard_oncroak(aTHX_ NULL);
1494 /* After that, propagate the error upwards. */
1499 static int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
1500 vmg_svt_free_cleanup_ud ud;
1501 const vmg_wizard *w;
1507 /* During global destruction, we cannot be sure that the wizard and its free
1508 * callback are still alive. */
1512 w = vmg_wizard_from_mg_nocheck(mg);
1514 /* So that it survives the temp cleanup below */
1515 SvREFCNT_inc_simple_void(sv);
1517 #if !(XSH_HAS_PERL_MAINT(5, 11, 0, 32686) || XSH_HAS_PERL(5, 12, 0))
1518 /* The previous magic tokens were freed but the magic chain wasn't updated, so
1519 * if you access the sv from the callback the old deleted magics will trigger
1520 * and cause memory misreads. Change 32686 solved it that way : */
1521 SvMAGIC_set(sv, mg);
1525 if (cxstack_ix < cxstack_max) {
1526 ud.in_eval = (CxTYPE(cxstack + cxstack_ix + 1) == CXt_EVAL);
1527 ud.base = ud.in_eval ? PL_scopestack[PL_scopestack_ix] : 0;
1536 PUSHSTACKi(PERLSI_MAGIC);
1540 /* This will bump the refcount of sv from 0 to 1 */
1541 #if VMG_CAREFUL_SELF_DESTRUCTION
1542 ud.rsv = newRV_inc(sv);
1545 PUSHs(sv_2mortal(newRV_inc(sv)));
1547 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
1549 XPUSHs(vmg_op_info(w->opinfo));
1555 vmg_call_sv(w->cb_free, G_SCALAR, vmg_svt_free_cleanup, &ud);
1557 if (XSH_CXT.depth == 0 && XSH_CXT.freed_tokens) {
1558 /* Free all the tokens in the chain but the current one (if it's present).
1559 * It will be taken care of by our caller, Perl_mg_free(). */
1560 vmg_magic_chain_free(XSH_CXT.freed_tokens, mg);
1561 XSH_CXT.freed_tokens = NULL;
1568 ret = (int) SvIV(svr);
1573 #if VMG_CAREFUL_SELF_DESTRUCTION
1574 /* Silently undo the ref - don't trigger destruction in the referent
1575 * for a second time */
1576 if (SvROK(ud.rsv) && SvRV(ud.rsv) == sv) {
1577 SvRV_set(ud.rsv, NULL);
1579 --SvREFCNT(sv); /* Silent */
1581 SvREFCNT_dec_NN(ud.rsv);
1587 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
1588 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
1591 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
1592 * mg->mg_ptr reference count */
1596 #define vmg_svt_free_noop vmg_svt_default_noop
1598 #if XSH_HAS_PERL_MAINT(5, 11, 0, 33256) || XSH_HAS_PERL(5, 12, 0)
1599 # define VMG_SVT_COPY_KEYLEN_TYPE I32
1601 # define VMG_SVT_COPY_KEYLEN_TYPE int
1604 /* ... copy magic .......................................................... */
1606 static int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1607 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1611 if (keylen == HEf_SVKEY) {
1614 keysv = newSVpvn(key, keylen);
1617 if (SvTYPE(sv) >= SVt_PVCV)
1618 nsv = sv_2mortal(newRV_inc(nsv));
1620 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
1622 if (keylen != HEf_SVKEY) {
1623 SvREFCNT_dec(keysv);
1629 static int vmg_svt_copy_noop(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key, VMG_SVT_COPY_KEYLEN_TYPE keylen) {
1633 /* ... dup magic ........................................................... */
1636 static int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
1639 #define vmg_svt_dup_noop vmg_svt_dup
1642 /* ... local magic ......................................................... */
1646 static int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
1647 const vmg_wizard *w = vmg_wizard_from_mg_nocheck(mg);
1649 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
1652 #define vmg_svt_local_noop vmg_svt_default_noop
1654 #endif /* MGf_LOCAL */
1656 /* ... uvar magic .......................................................... */
1660 static OP *vmg_pp_reset_rmg(pTHX) {
1661 SVOP *o = cSVOPx(PL_op);
1663 SvRMAGICAL_on(o->op_sv);
1669 static I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
1671 MAGIC *mg, *umg, *moremagic;
1672 SV *key = NULL, *newkey = NULL;
1675 umg = mg_find(sv, PERL_MAGIC_uvar);
1676 /* umg can't be NULL or we wouldn't be there. */
1678 ud = (vmg_uvar_ud *) umg->mg_ptr;
1680 if (ud->old_uf.uf_val)
1681 ud->old_uf.uf_val(aTHX_ action, sv);
1682 if (ud->old_uf.uf_set)
1683 ud->old_uf.uf_set(aTHX_ action, sv);
1685 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
1686 const vmg_wizard *w;
1688 /* mg may be freed later by the uvar call, so we need to fetch the next
1689 * token before reaching that fateful point. */
1690 moremagic = mg->mg_moremagic;
1692 switch (mg->mg_type) {
1693 case PERL_MAGIC_ext:
1695 case PERL_MAGIC_tied:
1702 w = vmg_wizard_from_mg(mg);
1711 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
1715 & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)) {
1718 vmg_cb_call2(w->cb_fetch, w->opinfo | VMG_CB_CALL_GUARD, sv,
1721 case HV_FETCH_ISSTORE:
1722 case HV_FETCH_LVALUE:
1723 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
1725 vmg_cb_call2(w->cb_store, w->opinfo | VMG_CB_CALL_GUARD, sv,
1728 case HV_FETCH_ISEXISTS:
1730 vmg_cb_call2(w->cb_exists, w->opinfo | VMG_CB_CALL_GUARD, sv,
1735 vmg_cb_call2(w->cb_delete, w->opinfo | VMG_CB_CALL_GUARD, sv,
1741 if (SvRMAGICAL(sv) && !tied && !(action & (HV_FETCH_ISSTORE|HV_DELETE))) {
1742 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
1743 * mistaken for a tied hash by the rest of hv_common. It will be reset by
1744 * the op_ppaddr of a new fake op injected between the current and the next
1747 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1751 PL_op = vmg_trampoline_bump(&XSH_CXT.reset_rmg, sv, PL_op);
1753 #else /* !VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1755 OP *nop = PL_op->op_next;
1758 if (nop && nop->op_ppaddr == vmg_pp_reset_rmg) {
1759 svop = (SVOP *) nop;
1761 NewOp(1101, svop, 1, SVOP);
1762 svop->op_type = OP_STUB;
1763 svop->op_ppaddr = vmg_pp_reset_rmg;
1764 svop->op_next = nop;
1766 svop->op_private = 0;
1768 PL_op->op_next = (OP *) svop;
1773 #endif /* VMG_RESET_RMG_NEEDS_TRAMPOLINE */
1781 #endif /* VMG_UVAR */
1783 /* --- Module setup/teardown ----------------------------------------------- */
1787 static void vmg_global_teardown_late_locked(pTHX_ void *ud) {
1788 #define vmg_global_teardown_late_locked(UD) vmg_global_teardown_late_locked(aTHX_ (UD))
1789 MUTEX_DESTROY(&vmg_op_name_init_mutex);
1790 MUTEX_DESTROY(&vmg_vtable_refcount_mutex);
1795 static signed char vmg_destruct_level(pTHX) {
1796 #define vmg_destruct_level() vmg_destruct_level(aTHX)
1799 lvl = PL_perl_destruct_level;
1803 const char *s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1806 #if XSH_HAS_PERL(5, 21, 3)
1807 if (strEQ(s, "-1")) {
1810 # if XSH_HAS_PERL(5, 21, 10)
1812 if (Perl_grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
1816 # else /* XSH_HAS_PERL(5, 21, 3) && !XSH_HAS_PERL(5, 21, 10) */
1817 i = Perl_grok_atou(s, NULL);
1820 #else /* !XSH_HAS_PERL(5, 21, 3) */
1832 #endif /* XSH_THREADSAFE */
1834 static void xsh_user_global_setup(pTHX) {
1836 MUTEX_INIT(&vmg_vtable_refcount_mutex);
1837 MUTEX_INIT(&vmg_op_name_init_mutex);
1843 static void xsh_user_local_setup(pTHX_ xsh_user_cxt_t *cxt) {
1847 for (c = OPc_NULL; c < OPc_MAX; ++c)
1848 cxt->b__op_stashes[c] = NULL;
1851 cxt->freed_tokens = NULL;
1853 #if VMG_PROPAGATE_ERRSV_NEEDS_TRAMPOLINE
1854 vmg_trampoline_init(&cxt->propagate_errsv, vmg_pp_propagate_errsv);
1856 #if VMG_RESET_RMG_NEEDS_TRAMPOLINE
1857 vmg_trampoline_init(&cxt->reset_rmg, vmg_pp_reset_rmg);
1860 stash = gv_stashpv(XSH_PACKAGE, 1);
1861 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1862 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1863 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1864 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1865 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1866 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1867 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_NOLEN",
1868 newSVuv(VMG_COMPAT_SCALAR_NOLEN));
1869 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1870 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1871 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID",
1872 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID));
1873 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1874 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1875 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1876 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1877 newCONSTSUB(stash, "VMG_COMPAT_HASH_DELETE_NOUVAR_VOID",
1878 newSVuv(VMG_COMPAT_HASH_DELETE_NOUVAR_VOID));
1879 newCONSTSUB(stash, "VMG_COMPAT_CODE_COPY_CLONE",
1880 newSVuv(VMG_COMPAT_CODE_COPY_CLONE));
1881 newCONSTSUB(stash, "VMG_COMPAT_GLOB_GET", newSVuv(VMG_COMPAT_GLOB_GET));
1882 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(XSH_PERL_PATCHLEVEL));
1883 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(XSH_THREADSAFE));
1884 newCONSTSUB(stash, "VMG_FORKSAFE", newSVuv(XSH_FORKSAFE));
1885 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1886 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1891 static void xsh_user_local_teardown(pTHX_ xsh_user_cxt_t *cxt) {
1892 if (cxt->depth == 0 && cxt->freed_tokens) {
1893 vmg_magic_chain_free(cxt->freed_tokens, NULL);
1894 cxt->freed_tokens = NULL;
1900 static void xsh_user_global_teardown(pTHX) {
1902 if (vmg_destruct_level() == 0)
1903 vmg_global_teardown_late_locked(NULL);
1905 xsh_teardown_late_register(vmg_global_teardown_late_locked, NULL);
1911 /* --- Macros for the XS section ------------------------------------------- */
1914 # define VMG_CVOK(C) \
1915 ((CvISXSUB(C) ? (void *) CvXSUB(C) : (void *) CvROOT(C)) ? 1 : 0)
1917 # define VMG_CVOK(C) (CvROOT(C) || CvXSUB(C))
1920 #define VMG_CBOK(S) ((SvTYPE(S) == SVt_PVCV) ? VMG_CVOK(S) : SvOK(S))
1922 #define VMG_SET_CB(S, N) { \
1924 if (SvOK(cb) && SvROK(cb)) { \
1927 SvREFCNT_inc_simple_void(cb); \
1936 #define VMG_SET_SVT_CB(S, N) { \
1938 if (SvOK(cb) && SvROK(cb)) { \
1940 if (VMG_CBOK(cb)) { \
1941 t->svt_ ## N = vmg_svt_ ## N; \
1942 SvREFCNT_inc_simple_void(cb); \
1944 t->svt_ ## N = vmg_svt_ ## N ## _noop; \
1948 t->svt_ ## N = NULL; \
1954 /* --- XS ------------------------------------------------------------------ */
1956 MODULE = Variable::Magic PACKAGE = Variable::Magic
1974 #endif /* XSH_THREADSAFE */
1981 SV *op_info, *copy_key;
1987 #endif /* MGf_LOCAL */
1990 #endif /* VMG_UVAR */
1991 ) { croak(vmg_wrongargnum); }
1994 w = vmg_wizard_alloc(SvOK(op_info) ? SvUV(op_info) : 0);
1995 t = vmg_vtable_vtbl(w->vtable);
1997 VMG_SET_CB(ST(i++), data);
1999 VMG_SET_SVT_CB(ST(i++), get);
2000 VMG_SET_SVT_CB(ST(i++), set);
2001 VMG_SET_SVT_CB(ST(i++), len);
2002 VMG_SET_SVT_CB(ST(i++), clear);
2003 VMG_SET_SVT_CB(ST(i++), free);
2004 VMG_SET_SVT_CB(ST(i++), copy);
2005 /* VMG_SET_SVT_CB(ST(i++), dup); */
2010 VMG_SET_SVT_CB(ST(i++), local);
2011 #endif /* MGf_LOCAL */
2013 VMG_SET_CB(ST(i++), fetch);
2014 VMG_SET_CB(ST(i++), store);
2015 VMG_SET_CB(ST(i++), exists);
2016 VMG_SET_CB(ST(i++), delete);
2019 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
2020 w->uvar = SvTRUE(copy_key) ? 2 : 1;
2021 #endif /* VMG_UVAR */
2023 RETVAL = newRV_noinc(vmg_wizard_sv_new(w));
2027 SV *cast(SV *sv, SV *wiz, ...)
2028 PROTOTYPE: \[$@%&*]$@
2030 const vmg_wizard *w = NULL;
2039 wiz = SvRV_const(wiz);
2040 w = vmg_wizard_from_sv(wiz);
2043 croak(vmg_invalid_wiz);
2044 RETVAL = newSVuv(vmg_cast(SvRV(sv), w, wiz, args, i));
2049 getdata(SV *sv, SV *wiz)
2050 PROTOTYPE: \[$@%&*]$
2052 const vmg_wizard *w = NULL;
2056 w = vmg_wizard_from_sv(SvRV_const(wiz));
2058 croak(vmg_invalid_wiz);
2059 data = vmg_data_get(SvRV(sv), w);
2065 SV *dispell(SV *sv, SV *wiz)
2066 PROTOTYPE: \[$@%&*]$
2068 const vmg_wizard *w = NULL;
2071 w = vmg_wizard_from_sv(SvRV_const(wiz));
2073 croak(vmg_invalid_wiz);
2074 RETVAL = newSVuv(vmg_dispell(SvRV(sv), w));