1 /* This file is part of the indirect Perl module.
2 * See http://search.cpan.org/dist/indirect/ */
4 #define PERL_NO_GET_CONTEXT
9 #define __PACKAGE__ "indirect"
10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
12 /* --- Compatibility wrappers ---------------------------------------------- */
23 # define Newx(v, n, c) New(0, v, n, c)
27 # define SvPV_const SvPV
30 #ifndef SvPV_nolen_const
31 # define SvPV_nolen_const SvPV_nolen
35 # define SvPVX_const SvPVX
38 #ifndef SvREFCNT_inc_simple_NN
39 # define SvREFCNT_inc_simple_NN SvREFCNT_inc
42 #ifndef sv_catpvn_nomg
43 # define sv_catpvn_nomg sv_catpvn
47 # define mPUSHp(P, L) PUSHs(sv_2mortal(newSVpvn((P), (L))))
51 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
55 # define HvNAME_get(H) HvNAME(H)
59 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
62 #define I_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
64 #if I_HAS_PERL(5, 10, 0) || defined(PL_parser)
66 # define PL_linestr PL_parser->linestr
69 # define PL_bufptr PL_parser->bufptr
72 # define PL_oldbufptr PL_parser->oldbufptr
76 # define PL_linestr PL_Ilinestr
79 # define PL_bufptr PL_Ibufptr
82 # define PL_oldbufptr PL_Ioldbufptr
86 #ifndef I_WORKAROUND_REQUIRE_PROPAGATION
87 # define I_WORKAROUND_REQUIRE_PROPAGATION !I_HAS_PERL(5, 10, 1)
90 /* ... Thread safety and multiplicity ...................................... */
92 /* Safe unless stated otherwise in Makefile.PL */
97 #ifndef I_MULTIPLICITY
98 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
99 # define I_MULTIPLICITY 1
101 # define I_MULTIPLICITY 0
104 #if I_MULTIPLICITY && !defined(tTHX)
105 # define tTHX PerlInterpreter*
108 #if I_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))
109 # define I_THREADSAFE 1
110 # ifndef MY_CXT_CLONE
111 # define MY_CXT_CLONE \
113 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
114 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
115 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
118 # define I_THREADSAFE 0
120 # define dMY_CXT dNOOP
122 # define MY_CXT indirect_globaldata
124 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
126 # define MY_CXT_INIT NOOP
128 # define MY_CXT_CLONE NOOP
131 /* --- Helpers ------------------------------------------------------------- */
133 /* ... Thread-safe hints ................................................... */
135 #if I_WORKAROUND_REQUIRE_PROPAGATION
142 #define I_HINT_STRUCT 1
144 #define I_HINT_CODE(H) ((H)->code)
146 #define I_HINT_FREE(H) { \
147 indirect_hint_t *h = (H); \
148 SvREFCNT_dec(h->code); \
149 PerlMemShared_free(h); \
152 #else /* I_WORKAROUND_REQUIRE_PROPAGATION */
154 typedef SV indirect_hint_t;
156 #define I_HINT_STRUCT 0
158 #define I_HINT_CODE(H) (H)
160 #define I_HINT_FREE(H) SvREFCNT_dec(H);
162 #endif /* !I_WORKAROUND_REQUIRE_PROPAGATION */
166 #define PTABLE_NAME ptable_hints
167 #define PTABLE_VAL_FREE(V) I_HINT_FREE(V)
176 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
177 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
179 #endif /* I_THREADSAFE */
181 /* Define the op->str ptable here because we need to be able to clean it during
190 } indirect_op_info_t;
192 #define PTABLE_NAME ptable
193 #define PTABLE_VAL_FREE(V) if (V) { Safefree(((indirect_op_info_t *) (V))->buf); Safefree(V); }
202 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
203 #define ptable_delete(T, K) ptable_delete(aTHX_ (T), (K))
204 #define ptable_clear(T) ptable_clear(aTHX_ (T))
205 #define ptable_free(T) ptable_free(aTHX_ (T))
207 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
211 ptable *tbl; /* It really is a ptable_hints */
221 STATIC SV *indirect_clone(pTHX_ SV *sv, tTHX owner) {
222 #define indirect_clone(S, O) indirect_clone(aTHX_ (S), (O))
227 if (SvTYPE(sv) == SVt_PVHV && HvNAME_get(sv))
230 param.stashes = stashes;
232 param.proto_perl = owner;
234 dupsv = sv_dup(sv, ¶m);
238 SvREFCNT_dec(stashes);
241 return SvREFCNT_inc(dupsv);
244 STATIC void indirect_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
246 indirect_hint_t *h1 = ent->val;
249 if (ud->owner == aTHX)
254 h2 = PerlMemShared_malloc(sizeof *h2);
255 h2->code = indirect_clone(h1->code, ud->owner);
256 #if I_WORKAROUND_REQUIRE_PROPAGATION
257 h2->require_tag = PTR2IV(indirect_clone(INT2PTR(SV *, h1->require_tag),
261 #else /* I_HINT_STRUCT */
263 h2 = indirect_clone(h1, ud->owner);
265 #endif /* !I_HINT_STRUCT */
267 ptable_hints_store(ud->tbl, ent->key, h2);
272 STATIC void indirect_thread_cleanup(pTHX_ void *ud) {
275 ptable_free(MY_CXT.map);
276 ptable_hints_free(MY_CXT.tbl);
279 #endif /* I_THREADSAFE */
281 #if I_WORKAROUND_REQUIRE_PROPAGATION
282 STATIC IV indirect_require_tag(pTHX) {
283 #define indirect_require_tag() indirect_require_tag(aTHX)
284 const CV *cv, *outside;
289 /* If for some reason the pragma is operational at run-time, try to discover
290 * the current cv in use. */
293 for (si = PL_curstackinfo; si; si = si->si_prev) {
296 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
297 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
299 switch (CxTYPE(cx)) {
302 /* The propagation workaround is only needed up to 5.10.0 and at that
303 * time format and sub contexts were still identical. And even later the
304 * cv members offsets should have been kept the same. */
306 goto get_enclosing_cv;
308 cv = cx->blk_eval.cv;
309 goto get_enclosing_cv;
320 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
325 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
327 STATIC SV *indirect_tag(pTHX_ SV *value) {
328 #define indirect_tag(V) indirect_tag(aTHX_ (V))
334 if (SvTYPE(value) >= SVt_PVCV) {
336 SvREFCNT_inc_simple_NN(code);
341 h = PerlMemShared_malloc(sizeof *h);
343 # if I_WORKAROUND_REQUIRE_PROPAGATION
344 h->require_tag = indirect_require_tag();
345 # endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
346 #else /* I_HINT_STRUCT */
348 #endif /* !I_HINT_STRUCT */
353 /* We only need for the key to be an unique tag for looking up the value later
354 * Allocated memory provides convenient unique identifiers, so that's why we
355 * use the hint as the key itself. */
356 ptable_hints_store(MY_CXT.tbl, h, h);
358 #endif /* I_THREADSAFE */
360 return newSViv(PTR2IV(h));
363 STATIC SV *indirect_detag(pTHX_ const SV *hint) {
364 #define indirect_detag(H) indirect_detag(aTHX_ (H))
367 if (!(hint && SvIOK(hint)))
370 h = INT2PTR(indirect_hint_t *, SvIVX(hint));
374 h = ptable_fetch(MY_CXT.tbl, h);
376 #endif /* I_THREADSAFE */
378 #if I_WORKAROUND_REQUIRE_PROPAGATION
379 if (indirect_require_tag() != h->require_tag)
381 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
383 return I_HINT_CODE(h);
386 STATIC U32 indirect_hash = 0;
388 STATIC SV *indirect_hint(pTHX) {
389 #define indirect_hint() indirect_hint(aTHX)
395 #ifdef cop_hints_fetch_pvn
396 hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__,
398 #elif I_HAS_PERL(5, 9, 5)
399 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
401 __PACKAGE__, __PACKAGE_LEN__,
406 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
413 return indirect_detag(hint);
416 /* ... op -> source position ............................................... */
418 STATIC void indirect_map_store(pTHX_ const OP *o, STRLEN pos, SV *sv, line_t line) {
419 #define indirect_map_store(O, P, N, L) indirect_map_store(aTHX_ (O), (P), (N), (L))
420 indirect_op_info_t *oi;
425 if (!(oi = ptable_fetch(MY_CXT.map, o))) {
426 Newx(oi, 1, indirect_op_info_t);
427 ptable_store(MY_CXT.map, o, oi);
433 s = SvPV_const(sv, len);
439 if (len > oi->size) {
441 Newx(oi->buf, len, char);
444 Copy(s, oi->buf, len, char);
451 STATIC const indirect_op_info_t *indirect_map_fetch(pTHX_ const OP *o) {
452 #define indirect_map_fetch(O) indirect_map_fetch(aTHX_ (O))
455 return ptable_fetch(MY_CXT.map, o);
458 STATIC void indirect_map_delete(pTHX_ const OP *o) {
459 #define indirect_map_delete(O) indirect_map_delete(aTHX_ (O))
462 ptable_delete(MY_CXT.map, o);
465 /* --- Check functions ----------------------------------------------------- */
467 STATIC int indirect_find(pTHX_ SV *sv, const char *s, STRLEN *pos) {
468 #define indirect_find(N, S, P) indirect_find(aTHX_ (N), (S), (P))
470 const char *p, *r = SvPV_const(sv, len);
472 if (len >= 1 && *r == '$') {
485 if (!isALNUM(p[len]))
487 /* p points to a word that has r as prefix, skip the rest of the word */
493 *pos = p - SvPVX_const(PL_linestr);
498 /* ... ck_const ............................................................ */
500 STATIC OP *(*indirect_old_ck_const)(pTHX_ OP *) = 0;
502 STATIC OP *indirect_ck_const(pTHX_ OP *o) {
503 o = indirect_old_ck_const(aTHX_ o);
505 if (indirect_hint()) {
508 if (SvPOK(sv) && (SvTYPE(sv) >= SVt_PV)) {
511 if (indirect_find(sv, PL_oldbufptr, &pos)) {
512 indirect_map_store(o, pos, sv, CopLINE(&PL_compiling));
518 indirect_map_delete(o);
522 /* ... ck_rv2sv ............................................................ */
524 STATIC OP *(*indirect_old_ck_rv2sv)(pTHX_ OP *) = 0;
526 STATIC OP *indirect_ck_rv2sv(pTHX_ OP *o) {
527 if (indirect_hint()) {
528 OP *op = cUNOPo->op_first;
530 const char *name = NULL;
532 OPCODE type = (OPCODE) op->op_type;
537 GV *gv = cGVOPx_gv(op);
543 if ((PL_opargs[type] & OA_CLASS_MASK) == OA_SVOP) {
544 SV *nsv = cSVOPx_sv(op);
545 if (SvPOK(nsv) && (SvTYPE(nsv) >= SVt_PV))
546 name = SvPV_const(nsv, len);
552 sv = sv_2mortal(newSVpvn("$", 1));
553 sv_catpvn_nomg(sv, name, len);
554 if (!indirect_find(sv, PL_oldbufptr, &pos)) {
555 /* If it failed, retry without the current stash */
556 const char *stash = HvNAME_get(PL_curstash);
557 STRLEN stashlen = HvNAMELEN_get(PL_curstash);
559 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
560 || name[stashlen] != ':' || name[stashlen+1] != ':') {
561 /* Failed again ? Try to remove main */
564 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
565 || name[stashlen] != ':' || name[stashlen+1] != ':')
569 sv_setpvn(sv, "$", 1);
571 sv_catpvn_nomg(sv, name + stashlen, len - stashlen);
572 if (!indirect_find(sv, PL_oldbufptr, &pos))
576 o = indirect_old_ck_rv2sv(aTHX_ o);
578 indirect_map_store(o, pos, sv, CopLINE(&PL_compiling));
583 o = indirect_old_ck_rv2sv(aTHX_ o);
585 indirect_map_delete(o);
589 /* ... ck_padany ........................................................... */
591 STATIC OP *(*indirect_old_ck_padany)(pTHX_ OP *) = 0;
593 STATIC OP *indirect_ck_padany(pTHX_ OP *o) {
594 o = indirect_old_ck_padany(aTHX_ o);
596 if (indirect_hint()) {
598 const char *s = PL_oldbufptr, *t = PL_bufptr - 1;
600 while (s < t && isSPACE(*s)) ++s;
601 if (*s == '$' && ++s <= t) {
602 while (s < t && isSPACE(*s)) ++s;
603 while (s < t && isSPACE(*t)) --t;
604 sv = sv_2mortal(newSVpvn("$", 1));
605 sv_catpvn_nomg(sv, s, t - s + 1);
606 indirect_map_store(o, s - SvPVX_const(PL_linestr),
607 sv, CopLINE(&PL_compiling));
612 indirect_map_delete(o);
616 /* ... ck_scope ............................................................ */
618 STATIC OP *(*indirect_old_ck_scope) (pTHX_ OP *) = 0;
619 STATIC OP *(*indirect_old_ck_lineseq)(pTHX_ OP *) = 0;
621 STATIC OP *indirect_ck_scope(pTHX_ OP *o) {
622 OP *(*old_ck)(pTHX_ OP *) = 0;
624 switch (o->op_type) {
625 case OP_SCOPE: old_ck = indirect_old_ck_scope; break;
626 case OP_LINESEQ: old_ck = indirect_old_ck_lineseq; break;
630 if (indirect_hint()) {
631 indirect_map_store(o, PL_oldbufptr - SvPVX_const(PL_linestr),
632 NULL, CopLINE(&PL_compiling));
636 indirect_map_delete(o);
640 /* We don't need to clean the map entries for leave ops because they can only
641 * be created by mutating from a lineseq. */
643 /* ... ck_method ........................................................... */
645 STATIC OP *(*indirect_old_ck_method)(pTHX_ OP *) = 0;
647 STATIC OP *indirect_ck_method(pTHX_ OP *o) {
648 if (indirect_hint()) {
649 OP *op = cUNOPo->op_first;
651 /* Indirect method call is only possible when the method is a bareword, so
652 * don't trip up on $obj->$meth. */
653 if (op && op->op_type == OP_CONST) {
654 const indirect_op_info_t *oi = indirect_map_fetch(op);
662 sv = sv_2mortal(newSVpvn(oi->buf, oi->len));
664 /* Keep the old line so that we really point to the first line of the
668 o = indirect_old_ck_method(aTHX_ o);
669 /* o may now be a method_named */
671 indirect_map_store(o, pos, sv, line);
677 o = indirect_old_ck_method(aTHX_ o);
679 indirect_map_delete(o);
683 /* ... ck_method_named ..................................................... */
685 /* "use foo/no foo" compiles its call to import/unimport directly to a
686 * method_named op. */
688 STATIC OP *(*indirect_old_ck_method_named)(pTHX_ OP *) = 0;
690 STATIC OP *indirect_ck_method_named(pTHX_ OP *o) {
691 if (indirect_hint()) {
697 if (!SvPOK(sv) || (SvTYPE(sv) < SVt_PV))
699 sv = sv_mortalcopy(sv);
701 if (!indirect_find(sv, PL_oldbufptr, &pos))
703 line = CopLINE(&PL_compiling);
705 o = indirect_old_ck_method_named(aTHX_ o);
707 indirect_map_store(o, pos, sv, line);
712 o = indirect_old_ck_method_named(aTHX_ o);
714 indirect_map_delete(o);
718 /* ... ck_entersub ......................................................... */
720 STATIC OP *(*indirect_old_ck_entersub)(pTHX_ OP *) = 0;
722 STATIC OP *indirect_ck_entersub(pTHX_ OP *o) {
723 SV *code = indirect_hint();
725 o = indirect_old_ck_entersub(aTHX_ o);
728 const indirect_op_info_t *moi, *ooi;
734 lop = (LISTOP *) oop;
735 if (!(lop->op_flags & OPf_KIDS))
738 } while (oop->op_type != OP_PUSHMARK);
739 oop = oop->op_sibling;
745 switch (oop->op_type) {
756 if (mop->op_type == OP_METHOD)
757 mop = cUNOPx(mop)->op_first;
758 else if (mop->op_type != OP_METHOD_NAMED)
761 moi = indirect_map_fetch(mop);
765 ooi = indirect_map_fetch(oop);
769 /* When positions are identical, the method and the object must have the
770 * same name. But it also means that it is an indirect call, as "foo->foo"
771 * results in different positions. */
772 if (moi->pos <= ooi->pos) {
780 file = sv_2mortal(newSVpv(CopFILE(&PL_compiling), 0));
782 file = sv_mortalcopy(CopFILESV(&PL_compiling));
787 mPUSHp(ooi->buf, ooi->len);
788 mPUSHp(moi->buf, moi->len);
793 call_sv(code, G_VOID);
806 STATIC U32 indirect_initialized = 0;
808 STATIC void indirect_teardown(pTHX_ void *root) {
809 if (!indirect_initialized)
819 ptable_free(MY_CXT.map);
821 ptable_hints_free(MY_CXT.tbl);
825 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_old_ck_const);
826 indirect_old_ck_const = 0;
827 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_old_ck_rv2sv);
828 indirect_old_ck_rv2sv = 0;
829 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_old_ck_padany);
830 indirect_old_ck_padany = 0;
831 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_old_ck_scope);
832 indirect_old_ck_scope = 0;
833 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_old_ck_lineseq);
834 indirect_old_ck_lineseq = 0;
836 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_old_ck_method);
837 indirect_old_ck_method = 0;
838 PL_check[OP_METHOD_NAMED] = MEMBER_TO_FPTR(indirect_old_ck_method_named);
839 indirect_old_ck_method_named = 0;
840 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_old_ck_entersub);
841 indirect_old_ck_entersub = 0;
843 indirect_initialized = 0;
846 STATIC void indirect_setup(pTHX) {
847 #define indirect_setup() indirect_setup(aTHX)
848 if (indirect_initialized)
854 MY_CXT.tbl = ptable_new();
857 MY_CXT.map = ptable_new();
860 indirect_old_ck_const = PL_check[OP_CONST];
861 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_ck_const);
862 indirect_old_ck_rv2sv = PL_check[OP_RV2SV];
863 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_ck_rv2sv);
864 indirect_old_ck_padany = PL_check[OP_PADANY];
865 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_ck_padany);
866 indirect_old_ck_scope = PL_check[OP_SCOPE];
867 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_ck_scope);
868 indirect_old_ck_lineseq = PL_check[OP_LINESEQ];
869 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_ck_scope);
871 indirect_old_ck_method = PL_check[OP_METHOD];
872 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_ck_method);
873 indirect_old_ck_method_named = PL_check[OP_METHOD_NAMED];
874 PL_check[OP_METHOD_NAMED] = MEMBER_TO_FPTR(indirect_ck_method_named);
875 indirect_old_ck_entersub = PL_check[OP_ENTERSUB];
876 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_ck_entersub);
879 call_atexit(indirect_teardown, aTHX);
881 call_atexit(indirect_teardown, NULL);
884 indirect_initialized = 1;
887 STATIC U32 indirect_booted = 0;
889 /* --- XS ------------------------------------------------------------------ */
891 MODULE = indirect PACKAGE = indirect
897 if (!indirect_booted++) {
900 PERL_HASH(indirect_hash, __PACKAGE__, __PACKAGE_LEN__);
902 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
903 newCONSTSUB(stash, "I_THREADSAFE", newSVuv(I_THREADSAFE));
904 newCONSTSUB(stash, "I_FORKSAFE", newSVuv(I_FORKSAFE));
921 ud.tbl = t = ptable_new();
922 ud.owner = MY_CXT.owner;
923 ptable_walk(MY_CXT.tbl, indirect_ptable_clone, &ud);
927 MY_CXT.map = ptable_new();
931 reap(3, indirect_thread_cleanup, NULL);
940 RETVAL = indirect_tag(value);