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)
65 # ifndef PL_lex_inwhat
66 # define PL_lex_inwhat PL_parser->lex_inwhat
69 # define PL_linestr PL_parser->linestr
72 # define PL_bufptr PL_parser->bufptr
75 # define PL_oldbufptr PL_parser->oldbufptr
78 # ifndef PL_lex_inwhat
79 # define PL_lex_inwhat PL_Ilex_inwhat
82 # define PL_linestr PL_Ilinestr
85 # define PL_bufptr PL_Ibufptr
88 # define PL_oldbufptr PL_Ioldbufptr
92 #ifndef I_WORKAROUND_REQUIRE_PROPAGATION
93 # define I_WORKAROUND_REQUIRE_PROPAGATION !I_HAS_PERL(5, 10, 1)
96 /* ... Thread safety and multiplicity ...................................... */
98 /* Safe unless stated otherwise in Makefile.PL */
100 # define I_FORKSAFE 1
103 #ifndef I_MULTIPLICITY
104 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
105 # define I_MULTIPLICITY 1
107 # define I_MULTIPLICITY 0
110 #if I_MULTIPLICITY && !defined(tTHX)
111 # define tTHX PerlInterpreter*
114 #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))
115 # define I_THREADSAFE 1
116 # ifndef MY_CXT_CLONE
117 # define MY_CXT_CLONE \
119 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
120 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
121 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
124 # define I_THREADSAFE 0
126 # define dMY_CXT dNOOP
128 # define MY_CXT indirect_globaldata
130 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
132 # define MY_CXT_INIT NOOP
134 # define MY_CXT_CLONE NOOP
137 /* --- Helpers ------------------------------------------------------------- */
139 /* ... Thread-safe hints ................................................... */
141 #if I_WORKAROUND_REQUIRE_PROPAGATION
148 #define I_HINT_STRUCT 1
150 #define I_HINT_CODE(H) ((H)->code)
152 #define I_HINT_FREE(H) { \
153 indirect_hint_t *h = (H); \
154 SvREFCNT_dec(h->code); \
155 PerlMemShared_free(h); \
158 #else /* I_WORKAROUND_REQUIRE_PROPAGATION */
160 typedef SV indirect_hint_t;
162 #define I_HINT_STRUCT 0
164 #define I_HINT_CODE(H) (H)
166 #define I_HINT_FREE(H) SvREFCNT_dec(H);
168 #endif /* !I_WORKAROUND_REQUIRE_PROPAGATION */
172 #define PTABLE_NAME ptable_hints
173 #define PTABLE_VAL_FREE(V) I_HINT_FREE(V)
182 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
183 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
185 #endif /* I_THREADSAFE */
187 /* Define the op->str ptable here because we need to be able to clean it during
195 } indirect_op_info_t;
197 #define PTABLE_NAME ptable
198 #define PTABLE_VAL_FREE(V) if (V) { Safefree(((indirect_op_info_t *) (V))->buf); Safefree(V); }
207 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
208 #define ptable_clear(T) ptable_clear(aTHX_ (T))
209 #define ptable_free(T) ptable_free(aTHX_ (T))
211 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
215 ptable *tbl; /* It really is a ptable_hints */
226 STATIC SV *indirect_clone(pTHX_ SV *sv, tTHX owner) {
227 #define indirect_clone(S, O) indirect_clone(aTHX_ (S), (O))
232 if (SvTYPE(sv) == SVt_PVHV && HvNAME_get(sv))
235 param.stashes = stashes;
237 param.proto_perl = owner;
239 dupsv = sv_dup(sv, ¶m);
243 SvREFCNT_dec(stashes);
246 return SvREFCNT_inc(dupsv);
249 STATIC void indirect_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
251 indirect_hint_t *h1 = ent->val;
254 if (ud->owner == aTHX)
259 h2 = PerlMemShared_malloc(sizeof *h2);
260 h2->code = indirect_clone(h1->code, ud->owner);
261 SvREFCNT_inc(h2->code);
262 #if I_WORKAROUND_REQUIRE_PROPAGATION
263 h2->require_tag = PTR2IV(indirect_clone(INT2PTR(SV *, h1->require_tag),
267 #else /* I_HINT_STRUCT */
269 h2 = indirect_clone(h1, ud->owner);
272 #endif /* !I_HINT_STRUCT */
274 ptable_hints_store(ud->tbl, ent->key, h2);
279 STATIC void indirect_thread_cleanup(pTHX_ void *ud) {
282 ptable_free(MY_CXT.map);
283 ptable_hints_free(MY_CXT.tbl);
286 #endif /* I_THREADSAFE */
288 #if I_WORKAROUND_REQUIRE_PROPAGATION
289 STATIC IV indirect_require_tag(pTHX) {
290 #define indirect_require_tag() indirect_require_tag(aTHX)
291 const CV *cv, *outside;
296 /* If for some reason the pragma is operational at run-time, try to discover
297 * the current cv in use. */
300 for (si = PL_curstackinfo; si; si = si->si_prev) {
303 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
304 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
306 switch (CxTYPE(cx)) {
309 /* The propagation workaround is only needed up to 5.10.0 and at that
310 * time format and sub contexts were still identical. And even later the
311 * cv members offsets should have been kept the same. */
313 goto get_enclosing_cv;
315 cv = cx->blk_eval.cv;
316 goto get_enclosing_cv;
327 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
332 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
334 STATIC SV *indirect_tag(pTHX_ SV *value) {
335 #define indirect_tag(V) indirect_tag(aTHX_ (V))
342 if (SvTYPE(value) >= SVt_PVCV) {
344 SvREFCNT_inc_simple_NN(code);
349 h = PerlMemShared_malloc(sizeof *h);
351 # if I_WORKAROUND_REQUIRE_PROPAGATION
352 h->require_tag = indirect_require_tag();
353 # endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
354 #else /* I_HINT_STRUCT */
356 #endif /* !I_HINT_STRUCT */
359 /* We only need for the key to be an unique tag for looking up the value later.
360 * Allocated memory provides convenient unique identifiers, so that's why we
361 * use the hint as the key itself. */
362 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))
373 if (!(hint && SvIOK(hint)))
376 h = INT2PTR(indirect_hint_t *, SvIVX(hint));
378 h = ptable_fetch(MY_CXT.tbl, h);
379 #endif /* I_THREADSAFE */
381 #if I_WORKAROUND_REQUIRE_PROPAGATION
382 if (indirect_require_tag() != h->require_tag)
384 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
386 return I_HINT_CODE(h);
389 STATIC U32 indirect_hash = 0;
391 STATIC SV *indirect_hint(pTHX) {
392 #define indirect_hint() indirect_hint(aTHX)
398 #if 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__,
413 return indirect_detag(hint);
416 /* ... op -> source position ............................................... */
418 STATIC void indirect_map_store(pTHX_ const OP *o, const char *src, SV *sv, line_t line) {
419 #define indirect_map_store(O, S, N, L) indirect_map_store(aTHX_ (O), (S), (N), (L))
420 indirect_op_info_t *oi;
425 /* When lex_inwhat is set, we're in a quotelike environment (qq, qr, but not q)
426 * In this case the linestr has temporarly changed, but the old buffer should
427 * still be alive somewhere. */
429 if (!PL_lex_inwhat) {
430 const char *pl_linestr = SvPVX_const(PL_linestr);
431 if (MY_CXT.linestr != pl_linestr) {
432 ptable_clear(MY_CXT.map);
433 MY_CXT.linestr = pl_linestr;
437 if (!(oi = ptable_fetch(MY_CXT.map, o))) {
438 Newx(oi, 1, indirect_op_info_t);
439 ptable_store(MY_CXT.map, o, oi);
445 s = SvPV_const(sv, len);
451 if (len > oi->size) {
453 Newx(oi->buf, len, char);
456 Copy(s, oi->buf, len, char);
463 STATIC const indirect_op_info_t *indirect_map_fetch(pTHX_ const OP *o) {
464 #define indirect_map_fetch(O) indirect_map_fetch(aTHX_ (O))
467 if (MY_CXT.linestr != SvPVX_const(PL_linestr))
470 return ptable_fetch(MY_CXT.map, o);
473 STATIC void indirect_map_delete(pTHX_ const OP *o) {
474 #define indirect_map_delete(O) indirect_map_delete(aTHX_ (O))
477 ptable_store(MY_CXT.map, o, NULL);
480 /* --- Check functions ----------------------------------------------------- */
482 STATIC const char *indirect_find(pTHX_ SV *sv, const char *s) {
483 #define indirect_find(N, S) indirect_find(aTHX_ (N), (S))
485 const char *p = NULL, *r = SvPV_const(sv, len);
487 if (len >= 1 && *r == '$') {
500 p = strstr(p + 1, r);
506 /* ... ck_const ............................................................ */
508 STATIC OP *(*indirect_old_ck_const)(pTHX_ OP *) = 0;
510 STATIC OP *indirect_ck_const(pTHX_ OP *o) {
511 o = CALL_FPTR(indirect_old_ck_const)(aTHX_ o);
513 if (indirect_hint()) {
515 if (SvPOK(sv) && (SvTYPE(sv) >= SVt_PV)) {
516 const char *s = indirect_find(sv, PL_oldbufptr);
517 indirect_map_store(o, s, sv, CopLINE(&PL_compiling));
522 indirect_map_delete(o);
526 /* ... ck_rv2sv ............................................................ */
528 STATIC OP *(*indirect_old_ck_rv2sv)(pTHX_ OP *) = 0;
530 STATIC OP *indirect_ck_rv2sv(pTHX_ OP *o) {
531 if (indirect_hint()) {
532 OP *op = cUNOPo->op_first;
534 const char *name = NULL, *s;
536 OPCODE type = (OPCODE) op->op_type;
541 GV *gv = cGVOPx_gv(op);
547 if ((PL_opargs[type] & OA_CLASS_MASK) == OA_SVOP) {
548 SV *nsv = cSVOPx_sv(op);
549 if (SvPOK(nsv) && (SvTYPE(nsv) >= SVt_PV))
550 name = SvPV_const(nsv, len);
556 sv = sv_2mortal(newSVpvn("$", 1));
557 sv_catpvn_nomg(sv, name, len);
558 s = indirect_find(sv, PL_oldbufptr);
559 if (!s) { /* If it failed, retry without the current stash */
560 const char *stash = HvNAME_get(PL_curstash);
561 STRLEN stashlen = HvNAMELEN_get(PL_curstash);
563 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
564 || name[stashlen] != ':' || name[stashlen+1] != ':') {
565 /* Failed again ? Try to remove main */
568 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
569 || name[stashlen] != ':' || name[stashlen+1] != ':')
573 sv_setpvn(sv, "$", 1);
575 sv_catpvn_nomg(sv, name + stashlen, len - stashlen);
576 s = indirect_find(sv, PL_oldbufptr);
581 o = CALL_FPTR(indirect_old_ck_rv2sv)(aTHX_ o);
582 indirect_map_store(o, s, sv, CopLINE(&PL_compiling));
587 o = CALL_FPTR(indirect_old_ck_rv2sv)(aTHX_ o);
589 indirect_map_delete(o);
593 /* ... ck_padany ........................................................... */
595 STATIC OP *(*indirect_old_ck_padany)(pTHX_ OP *) = 0;
597 STATIC OP *indirect_ck_padany(pTHX_ OP *o) {
598 o = CALL_FPTR(indirect_old_ck_padany)(aTHX_ o);
600 if (indirect_hint()) {
602 const char *s = PL_oldbufptr, *t = PL_bufptr - 1;
604 while (s < t && isSPACE(*s)) ++s;
605 if (*s == '$' && ++s <= t) {
606 while (s < t && isSPACE(*s)) ++s;
607 while (s < t && isSPACE(*t)) --t;
608 sv = sv_2mortal(newSVpvn("$", 1));
609 sv_catpvn_nomg(sv, s, t - s + 1);
610 indirect_map_store(o, s, sv, CopLINE(&PL_compiling));
615 indirect_map_delete(o);
619 /* ... ck_scope ............................................................ */
621 STATIC OP *(*indirect_old_ck_scope) (pTHX_ OP *) = 0;
622 STATIC OP *(*indirect_old_ck_lineseq)(pTHX_ OP *) = 0;
624 STATIC OP *indirect_ck_scope(pTHX_ OP *o) {
625 OP *(*old_ck)(pTHX_ OP *) = 0;
627 switch (o->op_type) {
628 case OP_SCOPE: old_ck = indirect_old_ck_scope; break;
629 case OP_LINESEQ: old_ck = indirect_old_ck_lineseq; break;
631 o = CALL_FPTR(old_ck)(aTHX_ o);
633 if (indirect_hint()) {
634 indirect_map_store(o, PL_oldbufptr, NULL, CopLINE(&PL_compiling));
638 indirect_map_delete(o);
642 /* We don't need to clean the map entries for leave ops because they can only
643 * be created by mutating from a lineseq. */
645 /* ... ck_method ........................................................... */
647 STATIC OP *(*indirect_old_ck_method)(pTHX_ OP *) = 0;
649 STATIC OP *indirect_ck_method(pTHX_ OP *o) {
650 if (indirect_hint()) {
651 OP *op = cUNOPo->op_first;
652 const indirect_op_info_t *oi = indirect_map_fetch(op);
653 const char *s = NULL;
657 if (oi && (s = oi->pos)) {
658 sv = sv_2mortal(newSVpvn(oi->buf, oi->len));
659 line = oi->line; /* Keep the old line so that we really point to the first */
662 if (!SvPOK(sv) || (SvTYPE(sv) < SVt_PV))
664 sv = sv_mortalcopy(sv);
665 s = indirect_find(sv, PL_oldbufptr);
666 line = CopLINE(&PL_compiling);
669 o = CALL_FPTR(indirect_old_ck_method)(aTHX_ o);
670 /* o may now be a method_named */
672 indirect_map_store(o, s, sv, line);
677 o = CALL_FPTR(indirect_old_ck_method)(aTHX_ o);
679 indirect_map_delete(o);
683 /* ... ck_entersub ......................................................... */
685 STATIC int indirect_is_indirect(const indirect_op_info_t *moi, const indirect_op_info_t *ooi) {
686 if (moi->pos > ooi->pos)
689 if (moi->pos == ooi->pos)
690 return moi->len == ooi->len && !memcmp(moi->buf, ooi->buf, moi->len);
695 STATIC OP *(*indirect_old_ck_entersub)(pTHX_ OP *) = 0;
697 STATIC OP *indirect_ck_entersub(pTHX_ OP *o) {
698 SV *code = indirect_hint();
700 o = CALL_FPTR(indirect_old_ck_entersub)(aTHX_ o);
703 const indirect_op_info_t *moi, *ooi;
709 lop = (LISTOP *) oop;
710 if (!(lop->op_flags & OPf_KIDS))
713 } while (oop->op_type != OP_PUSHMARK);
714 oop = oop->op_sibling;
720 switch (oop->op_type) {
731 if (mop->op_type == OP_METHOD)
732 mop = cUNOPx(mop)->op_first;
733 else if (mop->op_type != OP_METHOD_NAMED)
736 moi = indirect_map_fetch(mop);
737 if (!(moi && moi->pos))
740 ooi = indirect_map_fetch(oop);
741 if (!(ooi && ooi->pos))
744 if (indirect_is_indirect(moi, ooi)) {
752 file = sv_2mortal(newSVpv(CopFILE(&PL_compiling), 0));
754 file = sv_mortalcopy(CopFILESV(&PL_compiling));
759 mPUSHp(ooi->buf, ooi->len);
760 mPUSHp(moi->buf, moi->len);
765 call_sv(code, G_VOID);
778 STATIC U32 indirect_initialized = 0;
780 STATIC void indirect_teardown(pTHX_ void *root) {
783 if (!indirect_initialized)
791 ptable_free(MY_CXT.map);
793 ptable_hints_free(MY_CXT.tbl);
796 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_old_ck_const);
797 indirect_old_ck_const = 0;
798 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_old_ck_rv2sv);
799 indirect_old_ck_rv2sv = 0;
800 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_old_ck_padany);
801 indirect_old_ck_padany = 0;
802 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_old_ck_scope);
803 indirect_old_ck_scope = 0;
804 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_old_ck_lineseq);
805 indirect_old_ck_lineseq = 0;
807 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_old_ck_method);
808 indirect_old_ck_method = 0;
809 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_old_ck_entersub);
810 indirect_old_ck_entersub = 0;
812 indirect_initialized = 0;
815 STATIC void indirect_setup(pTHX) {
816 #define indirect_setup() indirect_setup(aTHX)
817 if (indirect_initialized)
823 MY_CXT.tbl = ptable_new();
826 MY_CXT.map = ptable_new();
827 MY_CXT.linestr = NULL;
830 indirect_old_ck_const = PL_check[OP_CONST];
831 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_ck_const);
832 indirect_old_ck_rv2sv = PL_check[OP_RV2SV];
833 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_ck_rv2sv);
834 indirect_old_ck_padany = PL_check[OP_PADANY];
835 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_ck_padany);
836 indirect_old_ck_scope = PL_check[OP_SCOPE];
837 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_ck_scope);
838 indirect_old_ck_lineseq = PL_check[OP_LINESEQ];
839 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_ck_scope);
841 indirect_old_ck_method = PL_check[OP_METHOD];
842 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_ck_method);
843 indirect_old_ck_entersub = PL_check[OP_ENTERSUB];
844 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_ck_entersub);
847 call_atexit(indirect_teardown, aTHX);
849 call_atexit(indirect_teardown, NULL);
852 indirect_initialized = 1;
855 STATIC U32 indirect_booted = 0;
857 /* --- XS ------------------------------------------------------------------ */
859 MODULE = indirect PACKAGE = indirect
865 if (!indirect_booted++) {
868 PERL_HASH(indirect_hash, __PACKAGE__, __PACKAGE_LEN__);
870 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
871 newCONSTSUB(stash, "I_THREADSAFE", newSVuv(I_THREADSAFE));
872 newCONSTSUB(stash, "I_FORKSAFE", newSVuv(I_FORKSAFE));
889 ud.tbl = t = ptable_new();
890 ud.owner = MY_CXT.owner;
891 ptable_walk(MY_CXT.tbl, indirect_ptable_clone, &ud);
895 MY_CXT.map = ptable_new();
896 MY_CXT.linestr = NULL;
900 reap(3, indirect_thread_cleanup, NULL);
909 RETVAL = indirect_tag(value);