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))))))
65 #if defined(ENTER_with_name) && !I_HAS_PERL(5, 11, 4)
66 # define ENTERn(N) ENTER_with_name(N)
68 # define ENTERn(N) ENTER
72 #if defined(LEAVE_with_name) && !I_HAS_PERL(5, 11, 4)
73 # define LEAVEn(N) LEAVE_with_name(N)
75 # define LEAVEn(N) LEAVE
78 #if I_HAS_PERL(5, 10, 0) || defined(PL_parser)
79 # ifndef PL_lex_inwhat
80 # define PL_lex_inwhat PL_parser->lex_inwhat
83 # define PL_linestr PL_parser->linestr
86 # define PL_bufptr PL_parser->bufptr
89 # define PL_oldbufptr PL_parser->oldbufptr
92 # ifndef PL_lex_inwhat
93 # define PL_lex_inwhat PL_Ilex_inwhat
96 # define PL_linestr PL_Ilinestr
99 # define PL_bufptr PL_Ibufptr
101 # ifndef PL_oldbufptr
102 # define PL_oldbufptr PL_Ioldbufptr
106 #ifndef I_WORKAROUND_REQUIRE_PROPAGATION
107 # define I_WORKAROUND_REQUIRE_PROPAGATION !I_HAS_PERL(5, 10, 1)
110 /* ... Thread safety and multiplicity ...................................... */
112 /* Safe unless stated otherwise in Makefile.PL */
114 # define I_FORKSAFE 1
117 #ifndef I_MULTIPLICITY
118 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
119 # define I_MULTIPLICITY 1
121 # define I_MULTIPLICITY 0
124 #if I_MULTIPLICITY && !defined(tTHX)
125 # define tTHX PerlInterpreter*
128 #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))
129 # define I_THREADSAFE 1
130 # ifndef MY_CXT_CLONE
131 # define MY_CXT_CLONE \
133 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
134 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
135 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
138 # define I_THREADSAFE 0
140 # define dMY_CXT dNOOP
142 # define MY_CXT indirect_globaldata
144 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
146 # define MY_CXT_INIT NOOP
148 # define MY_CXT_CLONE NOOP
151 /* --- Helpers ------------------------------------------------------------- */
153 /* ... Thread-safe hints ................................................... */
155 #if I_WORKAROUND_REQUIRE_PROPAGATION
162 #define I_HINT_STRUCT 1
164 #define I_HINT_CODE(H) ((H)->code)
166 #define I_HINT_FREE(H) { \
167 indirect_hint_t *h = (H); \
168 SvREFCNT_dec(h->code); \
169 PerlMemShared_free(h); \
172 #else /* I_WORKAROUND_REQUIRE_PROPAGATION */
174 typedef SV indirect_hint_t;
176 #define I_HINT_STRUCT 0
178 #define I_HINT_CODE(H) (H)
180 #define I_HINT_FREE(H) SvREFCNT_dec(H);
182 #endif /* !I_WORKAROUND_REQUIRE_PROPAGATION */
186 #define PTABLE_NAME ptable_hints
187 #define PTABLE_VAL_FREE(V) I_HINT_FREE(V)
196 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
197 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
199 #endif /* I_THREADSAFE */
201 /* Define the op->str ptable here because we need to be able to clean it during
209 } indirect_op_info_t;
211 #define PTABLE_NAME ptable
212 #define PTABLE_VAL_FREE(V) if (V) { Safefree(((indirect_op_info_t *) (V))->buf); Safefree(V); }
221 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
222 #define ptable_clear(T) ptable_clear(aTHX_ (T))
223 #define ptable_free(T) ptable_free(aTHX_ (T))
225 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
229 ptable *tbl; /* It really is a ptable_hints */
240 STATIC SV *indirect_clone(pTHX_ SV *sv, tTHX owner) {
241 #define indirect_clone(S, O) indirect_clone(aTHX_ (S), (O))
246 if (SvTYPE(sv) == SVt_PVHV && HvNAME_get(sv))
249 param.stashes = stashes;
251 param.proto_perl = owner;
253 dupsv = sv_dup(sv, ¶m);
257 SvREFCNT_dec(stashes);
260 return SvREFCNT_inc(dupsv);
263 STATIC void indirect_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
265 indirect_hint_t *h1 = ent->val;
268 if (ud->owner == aTHX)
273 h2 = PerlMemShared_malloc(sizeof *h2);
274 h2->code = indirect_clone(h1->code, ud->owner);
275 SvREFCNT_inc(h2->code);
276 #if I_WORKAROUND_REQUIRE_PROPAGATION
277 h2->cxreq = h1->cxreq;
280 #else /* I_HINT_STRUCT */
282 h2 = indirect_clone(h1, ud->owner);
285 #endif /* !I_HINT_STRUCT */
287 ptable_hints_store(ud->tbl, ent->key, h2);
290 STATIC void indirect_thread_cleanup(pTHX_ void *);
292 STATIC void indirect_thread_cleanup(pTHX_ void *ud) {
298 SAVEDESTRUCTOR_X(indirect_thread_cleanup, level);
302 PerlMemShared_free(level);
303 ptable_free(MY_CXT.map);
304 ptable_hints_free(MY_CXT.tbl);
308 #endif /* I_THREADSAFE */
310 #if I_WORKAROUND_REQUIRE_PROPAGATION
311 STATIC IV indirect_require_tag(pTHX) {
312 #define indirect_require_tag() indirect_require_tag(aTHX)
315 for (si = PL_curstackinfo; si; si = si->si_prev) {
318 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
319 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
321 if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE)
328 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
330 STATIC SV *indirect_tag(pTHX_ SV *value) {
331 #define indirect_tag(V) indirect_tag(aTHX_ (V))
338 if (SvTYPE(value) >= SVt_PVCV) {
340 SvREFCNT_inc_simple_NN(code);
345 h = PerlMemShared_malloc(sizeof *h);
347 # if I_WORKAROUND_REQUIRE_PROPAGATION
348 h->cxreq = indirect_require_tag();
349 # endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
350 #else /* I_HINT_STRUCT */
352 #endif /* !I_HINT_STRUCT */
355 /* We only need for the key to be an unique tag for looking up the value later.
356 * Allocated memory provides convenient unique identifiers, so that's why we
357 * use the hint as the key itself. */
358 ptable_hints_store(MY_CXT.tbl, h, h);
359 #endif /* I_THREADSAFE */
361 return newSViv(PTR2IV(h));
364 STATIC SV *indirect_detag(pTHX_ const SV *hint) {
365 #define indirect_detag(H) indirect_detag(aTHX_ (H))
369 if (!(hint && SvIOK(hint)))
372 h = INT2PTR(indirect_hint_t *, SvIVX(hint));
374 h = ptable_fetch(MY_CXT.tbl, h);
375 #endif /* I_THREADSAFE */
377 #if I_WORKAROUND_REQUIRE_PROPAGATION
378 if (indirect_require_tag() != h->cxreq)
380 #endif /* I_WORKAROUND_REQUIRE_PROPAGATION */
382 return I_HINT_CODE(h);
385 STATIC U32 indirect_hash = 0;
387 STATIC SV *indirect_hint(pTHX) {
388 #define indirect_hint() indirect_hint(aTHX)
394 #if I_HAS_PERL(5, 9, 5)
395 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
397 __PACKAGE__, __PACKAGE_LEN__,
402 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__,
409 return indirect_detag(hint);
412 /* ... op -> source position ............................................... */
414 STATIC void indirect_map_store(pTHX_ const OP *o, const char *src, SV *sv, line_t line) {
415 #define indirect_map_store(O, S, N, L) indirect_map_store(aTHX_ (O), (S), (N), (L))
416 indirect_op_info_t *oi;
421 /* When lex_inwhat is set, we're in a quotelike environment (qq, qr, but not q)
422 * In this case the linestr has temporarly changed, but the old buffer should
423 * still be alive somewhere. */
425 if (!PL_lex_inwhat) {
426 const char *pl_linestr = SvPVX_const(PL_linestr);
427 if (MY_CXT.linestr != pl_linestr) {
428 ptable_clear(MY_CXT.map);
429 MY_CXT.linestr = pl_linestr;
433 if (!(oi = ptable_fetch(MY_CXT.map, o))) {
434 Newx(oi, 1, indirect_op_info_t);
435 ptable_store(MY_CXT.map, o, oi);
441 s = SvPV_const(sv, len);
447 if (len > oi->size) {
449 Newx(oi->buf, len, char);
452 Copy(s, oi->buf, len, char);
459 STATIC const indirect_op_info_t *indirect_map_fetch(pTHX_ const OP *o) {
460 #define indirect_map_fetch(O) indirect_map_fetch(aTHX_ (O))
461 const indirect_op_info_t *val;
464 if (MY_CXT.linestr != SvPVX_const(PL_linestr))
467 return ptable_fetch(MY_CXT.map, o);
470 STATIC void indirect_map_delete(pTHX_ const OP *o) {
471 #define indirect_map_delete(O) indirect_map_delete(aTHX_ (O))
474 ptable_store(MY_CXT.map, o, NULL);
477 /* --- Check functions ----------------------------------------------------- */
479 STATIC const char *indirect_find(pTHX_ SV *sv, const char *s) {
480 #define indirect_find(N, S) indirect_find(aTHX_ (N), (S))
482 const char *p = NULL, *r = SvPV_const(sv, len);
484 if (len >= 1 && *r == '$') {
497 p = strstr(p + 1, r);
503 /* ... ck_const ............................................................ */
505 STATIC OP *(*indirect_old_ck_const)(pTHX_ OP *) = 0;
507 STATIC OP *indirect_ck_const(pTHX_ OP *o) {
508 o = CALL_FPTR(indirect_old_ck_const)(aTHX_ o);
510 if (indirect_hint()) {
512 if (SvPOK(sv) && (SvTYPE(sv) >= SVt_PV)) {
513 const char *s = indirect_find(sv, PL_oldbufptr);
514 indirect_map_store(o, s, sv, CopLINE(&PL_compiling));
519 indirect_map_delete(o);
523 /* ... ck_rv2sv ............................................................ */
525 STATIC OP *(*indirect_old_ck_rv2sv)(pTHX_ OP *) = 0;
527 STATIC OP *indirect_ck_rv2sv(pTHX_ OP *o) {
528 if (indirect_hint()) {
529 OP *op = cUNOPo->op_first;
531 const char *name = NULL, *s;
533 OPCODE type = (OPCODE) op->op_type;
538 GV *gv = cGVOPx_gv(op);
544 if ((PL_opargs[type] & OA_CLASS_MASK) == OA_SVOP) {
545 SV *nsv = cSVOPx_sv(op);
546 if (SvPOK(nsv) && (SvTYPE(nsv) >= SVt_PV))
547 name = SvPV_const(nsv, len);
553 sv = sv_2mortal(newSVpvn("$", 1));
554 sv_catpvn_nomg(sv, name, len);
555 s = indirect_find(sv, PL_oldbufptr);
556 if (!s) { /* If it failed, retry without the current stash */
557 const char *stash = HvNAME_get(PL_curstash);
558 STRLEN stashlen = HvNAMELEN_get(PL_curstash);
560 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
561 || name[stashlen] != ':' || name[stashlen+1] != ':') {
562 /* Failed again ? Try to remove main */
565 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
566 || name[stashlen] != ':' || name[stashlen+1] != ':')
570 sv_setpvn(sv, "$", 1);
572 sv_catpvn_nomg(sv, name + stashlen, len - stashlen);
573 s = indirect_find(sv, PL_oldbufptr);
578 o = CALL_FPTR(indirect_old_ck_rv2sv)(aTHX_ o);
579 indirect_map_store(o, s, sv, CopLINE(&PL_compiling));
584 o = CALL_FPTR(indirect_old_ck_rv2sv)(aTHX_ o);
586 indirect_map_delete(o);
590 /* ... ck_padany ........................................................... */
592 STATIC OP *(*indirect_old_ck_padany)(pTHX_ OP *) = 0;
594 STATIC OP *indirect_ck_padany(pTHX_ OP *o) {
595 o = CALL_FPTR(indirect_old_ck_padany)(aTHX_ o);
597 if (indirect_hint()) {
599 const char *s = PL_oldbufptr, *t = PL_bufptr - 1;
601 while (s < t && isSPACE(*s)) ++s;
602 if (*s == '$' && ++s <= t) {
603 while (s < t && isSPACE(*s)) ++s;
604 while (s < t && isSPACE(*t)) --t;
605 sv = sv_2mortal(newSVpvn("$", 1));
606 sv_catpvn_nomg(sv, s, t - s + 1);
607 indirect_map_store(o, s, 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;
628 o = CALL_FPTR(old_ck)(aTHX_ o);
630 if (indirect_hint()) {
631 indirect_map_store(o, PL_oldbufptr, NULL, CopLINE(&PL_compiling));
635 indirect_map_delete(o);
639 /* We don't need to clean the map entries for leave ops because they can only
640 * be created by mutating from a lineseq. */
642 /* ... ck_method ........................................................... */
644 STATIC OP *(*indirect_old_ck_method)(pTHX_ OP *) = 0;
646 STATIC OP *indirect_ck_method(pTHX_ OP *o) {
647 if (indirect_hint()) {
648 OP *op = cUNOPo->op_first;
649 const indirect_op_info_t *oi = indirect_map_fetch(op);
650 const char *s = NULL;
654 if (oi && (s = oi->pos)) {
655 sv = sv_2mortal(newSVpvn(oi->buf, oi->len));
656 line = oi->line; /* Keep the old line so that we really point to the first */
659 if (!SvPOK(sv) || (SvTYPE(sv) < SVt_PV))
661 sv = sv_mortalcopy(sv);
662 s = indirect_find(sv, PL_oldbufptr);
663 line = CopLINE(&PL_compiling);
666 o = CALL_FPTR(indirect_old_ck_method)(aTHX_ o);
667 /* o may now be a method_named */
669 indirect_map_store(o, s, sv, line);
674 o = CALL_FPTR(indirect_old_ck_method)(aTHX_ o);
676 indirect_map_delete(o);
680 /* ... ck_entersub ......................................................... */
682 STATIC int indirect_is_indirect(const indirect_op_info_t *moi, const indirect_op_info_t *ooi) {
683 if (moi->pos > ooi->pos)
686 if (moi->pos == ooi->pos)
687 return moi->len == ooi->len && !memcmp(moi->buf, ooi->buf, moi->len);
692 STATIC OP *(*indirect_old_ck_entersub)(pTHX_ OP *) = 0;
694 STATIC OP *indirect_ck_entersub(pTHX_ OP *o) {
695 SV *code = indirect_hint();
697 o = CALL_FPTR(indirect_old_ck_entersub)(aTHX_ o);
700 const indirect_op_info_t *moi, *ooi;
706 lop = (LISTOP *) oop;
707 if (!(lop->op_flags & OPf_KIDS))
710 } while (oop->op_type != OP_PUSHMARK);
711 oop = oop->op_sibling;
717 switch (oop->op_type) {
728 if (mop->op_type == OP_METHOD)
729 mop = cUNOPx(mop)->op_first;
730 else if (mop->op_type != OP_METHOD_NAMED)
733 moi = indirect_map_fetch(mop);
734 if (!(moi && moi->pos))
737 ooi = indirect_map_fetch(oop);
738 if (!(ooi && ooi->pos))
741 if (indirect_is_indirect(moi, ooi)) {
749 file = sv_2mortal(newSVpv(CopFILE(&PL_compiling), 0));
751 file = sv_mortalcopy(CopFILESV(&PL_compiling));
756 mPUSHp(ooi->buf, ooi->len);
757 mPUSHp(moi->buf, moi->len);
762 call_sv(code, G_VOID);
775 STATIC U32 indirect_initialized = 0;
777 STATIC void indirect_teardown(pTHX_ void *root) {
780 if (!indirect_initialized)
788 ptable_free(MY_CXT.map);
790 ptable_hints_free(MY_CXT.tbl);
793 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_old_ck_const);
794 indirect_old_ck_const = 0;
795 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_old_ck_rv2sv);
796 indirect_old_ck_rv2sv = 0;
797 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_old_ck_padany);
798 indirect_old_ck_padany = 0;
799 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_old_ck_scope);
800 indirect_old_ck_scope = 0;
801 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_old_ck_lineseq);
802 indirect_old_ck_lineseq = 0;
804 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_old_ck_method);
805 indirect_old_ck_method = 0;
806 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_old_ck_entersub);
807 indirect_old_ck_entersub = 0;
809 indirect_initialized = 0;
812 STATIC void indirect_setup(pTHX) {
813 #define indirect_setup() indirect_setup(aTHX)
814 if (indirect_initialized)
819 MY_CXT.tbl = ptable_new();
822 MY_CXT.map = ptable_new();
823 MY_CXT.linestr = NULL;
825 indirect_old_ck_const = PL_check[OP_CONST];
826 PL_check[OP_CONST] = MEMBER_TO_FPTR(indirect_ck_const);
827 indirect_old_ck_rv2sv = PL_check[OP_RV2SV];
828 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(indirect_ck_rv2sv);
829 indirect_old_ck_padany = PL_check[OP_PADANY];
830 PL_check[OP_PADANY] = MEMBER_TO_FPTR(indirect_ck_padany);
831 indirect_old_ck_scope = PL_check[OP_SCOPE];
832 PL_check[OP_SCOPE] = MEMBER_TO_FPTR(indirect_ck_scope);
833 indirect_old_ck_lineseq = PL_check[OP_LINESEQ];
834 PL_check[OP_LINESEQ] = MEMBER_TO_FPTR(indirect_ck_scope);
836 indirect_old_ck_method = PL_check[OP_METHOD];
837 PL_check[OP_METHOD] = MEMBER_TO_FPTR(indirect_ck_method);
838 indirect_old_ck_entersub = PL_check[OP_ENTERSUB];
839 PL_check[OP_ENTERSUB] = MEMBER_TO_FPTR(indirect_ck_entersub);
842 call_atexit(indirect_teardown, aTHX);
844 call_atexit(indirect_teardown, NULL);
847 indirect_initialized = 1;
850 STATIC U32 indirect_booted = 0;
852 /* --- XS ------------------------------------------------------------------ */
854 MODULE = indirect PACKAGE = indirect
860 if (!indirect_booted++) {
863 PERL_HASH(indirect_hash, __PACKAGE__, __PACKAGE_LEN__);
865 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
866 newCONSTSUB(stash, "I_THREADSAFE", newSVuv(I_THREADSAFE));
867 newCONSTSUB(stash, "I_FORKSAFE", newSVuv(I_FORKSAFE));
885 ud.tbl = t = ptable_new();
886 ud.owner = MY_CXT.owner;
887 ptable_walk(MY_CXT.tbl, indirect_ptable_clone, &ud);
891 MY_CXT.map = ptable_new();
892 MY_CXT.linestr = NULL;
897 level = PerlMemShared_malloc(sizeof *level);
900 SAVEDESTRUCTOR_X(indirect_thread_cleanup, level);
910 RETVAL = indirect_tag(value);