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 */
222 STATIC SV *indirect_clone(pTHX_ SV *sv, tTHX owner) {
223 #define indirect_clone(S, O) indirect_clone(aTHX_ (S), (O))
231 if (SvTYPE(sv) == SVt_PVHV && HvNAME_get(sv))
234 param.stashes = stashes;
236 param.proto_perl = owner;
238 dupsv = sv_dup(sv, ¶m);
242 SvREFCNT_dec(stashes);
245 return SvREFCNT_inc(dupsv);
248 STATIC void indirect_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
250 indirect_hint_t *h1 = ent->val;
253 if (ud->owner == aTHX)
258 h2 = PerlMemShared_malloc(sizeof *h2);
259 h2->code = indirect_clone(h1->code, ud->owner);
260 #if I_WORKAROUND_REQUIRE_PROPAGATION
261 h2->require_tag = PTR2IV(indirect_clone(INT2PTR(SV *, h1->require_tag),
265 #else /* I_HINT_STRUCT */
267 h2 = indirect_clone(h1, ud->owner);
269 #endif /* !I_HINT_STRUCT */
271 ptable_hints_store(ud->tbl, ent->key, h2);
276 STATIC void indirect_thread_cleanup(pTHX_ void *ud) {
279 SvREFCNT_dec(MY_CXT.global_code);
280 ptable_free(MY_CXT.map);
281 ptable_hints_free(MY_CXT.tbl);
284 #endif /* I_THREADSAFE */
286 #if I_WORKAROUND_REQUIRE_PROPAGATION
287 STATIC IV indirect_require_tag(pTHX) {
288 #define indirect_require_tag() indirect_require_tag(aTHX)
289 const CV *cv, *outside;
294 /* If for some reason the pragma is operational at run-time, try to discover
295 * the current cv in use. */
298 for (si = PL_curstackinfo; si; si = si->si_prev) {
301 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
302 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
304 switch (CxTYPE(cx)) {
307 /* The propagation workaround is only needed up to 5.10.0 and at that
308 * time format and sub contexts were still identical. And even later the
309 * cv members offsets should have been kept the same. */
311 goto get_enclosing_cv;
313 cv = cx->blk_eval.cv;
314 goto get_enclosing_cv;
325 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
330 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
332 STATIC SV *indirect_tag(pTHX_ SV *value) {
333 #define indirect_tag(V) indirect_tag(aTHX_ (V))
339 if (SvTYPE(value) >= SVt_PVCV) {
341 SvREFCNT_inc_simple_NN(code);
346 h = PerlMemShared_malloc(sizeof *h);
348 # if I_WORKAROUND_REQUIRE_PROPAGATION
349 h->require_tag = indirect_require_tag();
350 # endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
351 #else /* I_HINT_STRUCT */
353 #endif /* !I_HINT_STRUCT */
358 /* We only need for the key to be an unique tag for looking up the value later
359 * Allocated memory provides convenient unique identifiers, so that's why we
360 * use the hint as the key itself. */
361 ptable_hints_store(MY_CXT.tbl, h, h);
363 #endif /* I_THREADSAFE */
365 return newSViv(PTR2IV(h));
368 STATIC SV *indirect_detag(pTHX_ const SV *hint) {
369 #define indirect_detag(H) indirect_detag(aTHX_ (H))
371 #if I_THREADSAFE || I_WORKAROUND_REQUIRE_PROPAGATION
375 h = INT2PTR(indirect_hint_t *, SvIVX(hint));
377 h = ptable_fetch(MY_CXT.tbl, h);
378 #endif /* I_THREADSAFE */
380 #if I_WORKAROUND_REQUIRE_PROPAGATION
381 if (indirect_require_tag() != h->require_tag)
382 return MY_CXT.global_code;
383 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
385 return I_HINT_CODE(h);
388 STATIC U32 indirect_hash = 0;
390 STATIC SV *indirect_hint(pTHX) {
391 #define indirect_hint() indirect_hint(aTHX)
397 #ifdef cop_hints_fetch_pvn
398 hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__,
400 #elif I_HAS_PERL(5, 9, 5)
401 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
403 __PACKAGE__, __PACKAGE_LEN__,
408 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
414 if (hint && SvIOK(hint))
415 return indirect_detag(hint);
418 return MY_CXT.global_code;
422 /* ... op -> source position ............................................... */
424 STATIC void indirect_map_store(pTHX_ const OP *o, STRLEN pos, SV *sv, line_t line) {
425 #define indirect_map_store(O, P, N, L) indirect_map_store(aTHX_ (O), (P), (N), (L))
426 indirect_op_info_t *oi;
431 if (!(oi = ptable_fetch(MY_CXT.map, o))) {
432 Newx(oi, 1, indirect_op_info_t);
433 ptable_store(MY_CXT.map, o, oi);
439 s = SvPV_const(sv, len);
445 if (len > oi->size) {
447 Newx(oi->buf, len, char);
450 Copy(s, oi->buf, len, char);
457 STATIC const indirect_op_info_t *indirect_map_fetch(pTHX_ const OP *o) {
458 #define indirect_map_fetch(O) indirect_map_fetch(aTHX_ (O))
461 return ptable_fetch(MY_CXT.map, o);
464 STATIC void indirect_map_delete(pTHX_ const OP *o) {
465 #define indirect_map_delete(O) indirect_map_delete(aTHX_ (O))
468 ptable_delete(MY_CXT.map, o);
471 /* --- Check functions ----------------------------------------------------- */
473 STATIC int indirect_find(pTHX_ SV *sv, const char *s, STRLEN *pos) {
474 #define indirect_find(N, S, P) indirect_find(aTHX_ (N), (S), (P))
476 const char *p, *r = SvPV_const(sv, len);
478 if (len >= 1 && *r == '$') {
491 if (!isALNUM(p[len]))
493 /* p points to a word that has r as prefix, skip the rest of the word */
499 *pos = p - SvPVX_const(PL_linestr);
504 /* ... ck_const ............................................................ */
506 STATIC OP *(*indirect_old_ck_const)(pTHX_ OP *) = 0;
508 STATIC OP *indirect_ck_const(pTHX_ OP *o) {
509 o = indirect_old_ck_const(aTHX_ o);
511 if (indirect_hint()) {
514 if (SvPOK(sv) && (SvTYPE(sv) >= SVt_PV)) {
517 if (indirect_find(sv, PL_oldbufptr, &pos)) {
518 indirect_map_store(o, pos, sv, CopLINE(&PL_compiling));
524 indirect_map_delete(o);
528 /* ... ck_rv2sv ............................................................ */
530 STATIC OP *(*indirect_old_ck_rv2sv)(pTHX_ OP *) = 0;
532 STATIC OP *indirect_ck_rv2sv(pTHX_ OP *o) {
533 if (indirect_hint()) {
534 OP *op = cUNOPo->op_first;
536 const char *name = NULL;
538 OPCODE type = (OPCODE) op->op_type;
543 GV *gv = cGVOPx_gv(op);
549 if ((PL_opargs[type] & OA_CLASS_MASK) == OA_SVOP) {
550 SV *nsv = cSVOPx_sv(op);
551 if (SvPOK(nsv) && (SvTYPE(nsv) >= SVt_PV))
552 name = SvPV_const(nsv, len);
558 sv = sv_2mortal(newSVpvn("$", 1));
559 sv_catpvn_nomg(sv, name, len);
560 if (!indirect_find(sv, PL_oldbufptr, &pos)) {
561 /* If it failed, retry without the current stash */
562 const char *stash = HvNAME_get(PL_curstash);
563 STRLEN stashlen = HvNAMELEN_get(PL_curstash);
565 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
566 || name[stashlen] != ':' || name[stashlen+1] != ':') {
567 /* Failed again ? Try to remove main */
570 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
571 || name[stashlen] != ':' || name[stashlen+1] != ':')
575 sv_setpvn(sv, "$", 1);
577 sv_catpvn_nomg(sv, name + stashlen, len - stashlen);
578 if (!indirect_find(sv, PL_oldbufptr, &pos))
582 o = indirect_old_ck_rv2sv(aTHX_ o);
584 indirect_map_store(o, pos, sv, CopLINE(&PL_compiling));
589 o = indirect_old_ck_rv2sv(aTHX_ o);
591 indirect_map_delete(o);
595 /* ... ck_padany ........................................................... */
597 STATIC OP *(*indirect_old_ck_padany)(pTHX_ OP *) = 0;
599 STATIC OP *indirect_ck_padany(pTHX_ OP *o) {
600 o = indirect_old_ck_padany(aTHX_ o);
602 if (indirect_hint()) {
604 const char *s = PL_oldbufptr, *t = PL_bufptr - 1;
606 while (s < t && isSPACE(*s)) ++s;
607 if (*s == '$' && ++s <= t) {
608 while (s < t && isSPACE(*s)) ++s;
609 while (s < t && isSPACE(*t)) --t;
610 sv = sv_2mortal(newSVpvn("$", 1));
611 sv_catpvn_nomg(sv, s, t - s + 1);
612 indirect_map_store(o, s - SvPVX_const(PL_linestr),
613 sv, CopLINE(&PL_compiling));
618 indirect_map_delete(o);
622 /* ... ck_scope ............................................................ */
624 STATIC OP *(*indirect_old_ck_scope) (pTHX_ OP *) = 0;
625 STATIC OP *(*indirect_old_ck_lineseq)(pTHX_ OP *) = 0;
627 STATIC OP *indirect_ck_scope(pTHX_ OP *o) {
628 OP *(*old_ck)(pTHX_ OP *) = 0;
630 switch (o->op_type) {
631 case OP_SCOPE: old_ck = indirect_old_ck_scope; break;
632 case OP_LINESEQ: old_ck = indirect_old_ck_lineseq; break;
636 if (indirect_hint()) {
637 indirect_map_store(o, PL_oldbufptr - SvPVX_const(PL_linestr),
638 NULL, CopLINE(&PL_compiling));
642 indirect_map_delete(o);
646 /* We don't need to clean the map entries for leave ops because they can only
647 * be created by mutating from a lineseq. */
649 /* ... ck_method ........................................................... */
651 STATIC OP *(*indirect_old_ck_method)(pTHX_ OP *) = 0;
653 STATIC OP *indirect_ck_method(pTHX_ OP *o) {
654 if (indirect_hint()) {
655 OP *op = cUNOPo->op_first;
657 /* Indirect method call is only possible when the method is a bareword, so
658 * don't trip up on $obj->$meth. */
659 if (op && op->op_type == OP_CONST) {
660 const indirect_op_info_t *oi = indirect_map_fetch(op);
668 sv = sv_2mortal(newSVpvn(oi->buf, oi->len));
670 /* Keep the old line so that we really point to the first line of the
674 o = indirect_old_ck_method(aTHX_ o);
675 /* o may now be a method_named */
677 indirect_map_store(o, pos, sv, line);
683 o = indirect_old_ck_method(aTHX_ o);
685 indirect_map_delete(o);
689 /* ... ck_method_named ..................................................... */
691 /* "use foo/no foo" compiles its call to import/unimport directly to a
692 * method_named op. */
694 STATIC OP *(*indirect_old_ck_method_named)(pTHX_ OP *) = 0;
696 STATIC OP *indirect_ck_method_named(pTHX_ OP *o) {
697 if (indirect_hint()) {
703 if (!SvPOK(sv) || (SvTYPE(sv) < SVt_PV))
705 sv = sv_mortalcopy(sv);
707 if (!indirect_find(sv, PL_oldbufptr, &pos))
709 line = CopLINE(&PL_compiling);
711 o = indirect_old_ck_method_named(aTHX_ o);
713 indirect_map_store(o, pos, sv, line);
718 o = indirect_old_ck_method_named(aTHX_ o);
720 indirect_map_delete(o);
724 /* ... ck_entersub ......................................................... */
726 STATIC OP *(*indirect_old_ck_entersub)(pTHX_ OP *) = 0;
728 STATIC OP *indirect_ck_entersub(pTHX_ OP *o) {
729 SV *code = indirect_hint();
731 o = indirect_old_ck_entersub(aTHX_ o);
734 const indirect_op_info_t *moi, *ooi;
740 lop = (LISTOP *) oop;
741 if (!(lop->op_flags & OPf_KIDS))
744 } while (oop->op_type != OP_PUSHMARK);
745 oop = oop->op_sibling;
751 switch (oop->op_type) {
762 if (mop->op_type == OP_METHOD)
763 mop = cUNOPx(mop)->op_first;
764 else if (mop->op_type != OP_METHOD_NAMED)
767 moi = indirect_map_fetch(mop);
771 ooi = indirect_map_fetch(oop);
775 /* When positions are identical, the method and the object must have the
776 * same name. But it also means that it is an indirect call, as "foo->foo"
777 * results in different positions. */
778 if (moi->pos <= ooi->pos) {
786 file = sv_2mortal(newSVpv(CopFILE(&PL_compiling), 0));
788 file = sv_mortalcopy(CopFILESV(&PL_compiling));
793 mPUSHp(ooi->buf, ooi->len);
794 mPUSHp(moi->buf, moi->len);
799 call_sv(code, G_VOID);
812 STATIC U32 indirect_initialized = 0;
814 STATIC void indirect_teardown(pTHX_ void *root) {
815 if (!indirect_initialized)
825 ptable_free(MY_CXT.map);
827 ptable_hints_free(MY_CXT.tbl);
831 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_old_ck_const);
832 indirect_old_ck_const = 0;
833 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_old_ck_rv2sv);
834 indirect_old_ck_rv2sv = 0;
835 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_old_ck_padany);
836 indirect_old_ck_padany = 0;
837 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_old_ck_scope);
838 indirect_old_ck_scope = 0;
839 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_old_ck_lineseq);
840 indirect_old_ck_lineseq = 0;
842 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_old_ck_method);
843 indirect_old_ck_method = 0;
844 PL_check[OP_METHOD_NAMED] = MEMBER_TO_FPTR(indirect_old_ck_method_named);
845 indirect_old_ck_method_named = 0;
846 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_old_ck_entersub);
847 indirect_old_ck_entersub = 0;
849 indirect_initialized = 0;
852 STATIC void indirect_setup(pTHX) {
853 #define indirect_setup() indirect_setup(aTHX)
854 if (indirect_initialized)
860 MY_CXT.tbl = ptable_new();
863 MY_CXT.map = ptable_new();
864 MY_CXT.global_code = NULL;
867 indirect_old_ck_const = PL_check[OP_CONST];
868 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_ck_const);
869 indirect_old_ck_rv2sv = PL_check[OP_RV2SV];
870 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_ck_rv2sv);
871 indirect_old_ck_padany = PL_check[OP_PADANY];
872 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_ck_padany);
873 indirect_old_ck_scope = PL_check[OP_SCOPE];
874 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_ck_scope);
875 indirect_old_ck_lineseq = PL_check[OP_LINESEQ];
876 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_ck_scope);
878 indirect_old_ck_method = PL_check[OP_METHOD];
879 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_ck_method);
880 indirect_old_ck_method_named = PL_check[OP_METHOD_NAMED];
881 PL_check[OP_METHOD_NAMED] = MEMBER_TO_FPTR(indirect_ck_method_named);
882 indirect_old_ck_entersub = PL_check[OP_ENTERSUB];
883 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_ck_entersub);
886 call_atexit(indirect_teardown, aTHX);
888 call_atexit(indirect_teardown, NULL);
891 indirect_initialized = 1;
894 STATIC U32 indirect_booted = 0;
896 /* --- XS ------------------------------------------------------------------ */
898 MODULE = indirect PACKAGE = indirect
904 if (!indirect_booted++) {
907 PERL_HASH(indirect_hash, __PACKAGE__, __PACKAGE_LEN__);
909 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
910 newCONSTSUB(stash, "I_THREADSAFE", newSVuv(I_THREADSAFE));
911 newCONSTSUB(stash, "I_FORKSAFE", newSVuv(I_FORKSAFE));
929 ud.tbl = t = ptable_new();
930 ud.owner = MY_CXT.owner;
931 ptable_walk(MY_CXT.tbl, indirect_ptable_clone, &ud);
932 global_code_dup = indirect_clone(MY_CXT.global_code, MY_CXT.owner);
936 MY_CXT.map = ptable_new();
939 MY_CXT.global_code = global_code_dup;
941 reap(3, indirect_thread_cleanup, NULL);
950 RETVAL = indirect_tag(value);
960 else if (SvROK(code))
964 SvREFCNT_dec(MY_CXT.global_code);
965 MY_CXT.global_code = SvREFCNT_inc(code);