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 /* --- XS helpers ---------------------------------------------------------- */
11 #define XSH_PACKAGE "indirect"
18 /* ... op => source position map ........................................... */
28 #define PTABLE_NAME ptable
29 #define PTABLE_VAL_FREE(V) if (V) { indirect_op_info_t *oi = (V); XSH_LOCAL_FREE(oi->buf, oi->size, char); XSH_LOCAL_FREE(oi, 1, indirect_op_info_t); }
30 #define PTABLE_NEED_DELETE 1
31 #define PTABLE_NEED_WALK 0
33 #include "xsh/ptable.h"
35 /* XSH_LOCAL_FREE() always need aTHX */
36 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
37 #define ptable_delete(T, K) ptable_delete(aTHX_ (T), (K))
38 #define ptable_clear(T) ptable_clear(aTHX_ (T))
39 #define ptable_free(T) ptable_free(aTHX_ (T))
41 /* ... Lexical hints ....................................................... */
43 #define XSH_HINTS_TYPE_SV 1
45 #include "xsh/hints.h"
47 /* ... Thread-local storage ................................................ */
54 #define XSH_THREADS_USER_CONTEXT 1
55 #define XSH_THREADS_USER_CLONE_NEEDS_DUP 1
56 #define XSH_THREADS_COMPILE_TIME_PROTECTION 1
60 static void xsh_user_clone(pTHX_ const xsh_user_cxt_t *old_cxt, xsh_user_cxt_t *new_cxt, CLONE_PARAMS *params) {
61 new_cxt->map = ptable_new(32);
62 new_cxt->global_code = xsh_dup_inc(old_cxt->global_code, params);
67 #endif /* XSH_THREADSAFE */
69 #include "xsh/threads.h"
71 /* ... Lexical hints, continued ............................................ */
73 static SV *indirect_hint(pTHX) {
74 #define indirect_hint() indirect_hint(aTHX)
77 #if XSH_HAS_PERL(5, 10, 0) || defined(PL_parser)
82 hint = xsh_hints_fetch();
83 if (hint && SvOK(hint)) {
84 return xsh_hints_detag(hint);
87 if (xsh_is_loaded(&XSH_CXT))
88 return XSH_CXT.global_code;
94 /* --- Compatibility wrappers ---------------------------------------------- */
97 # define SvPV_const SvPV
100 #ifndef SvPV_nolen_const
101 # define SvPV_nolen_const SvPV_nolen
105 # define SvPVX_const SvPVX
108 #ifndef SvREFCNT_inc_simple_void_NN
109 # ifdef SvREFCNT_inc_simple_NN
110 # define SvREFCNT_inc_simple_void_NN SvREFCNT_inc_simple_NN
112 # define SvREFCNT_inc_simple_void_NN SvREFCNT_inc
116 #ifndef sv_catpvn_nomg
117 # define sv_catpvn_nomg sv_catpvn
121 # define mPUSHp(P, L) PUSHs(sv_2mortal(newSVpvn((P), (L))))
125 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
129 # define HvNAME_get(H) HvNAME(H)
132 #ifndef HvNAMELEN_get
133 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
136 #if XSH_HAS_PERL(5, 10, 0) || defined(PL_parser)
138 # define PL_linestr PL_parser->linestr
141 # define PL_bufptr PL_parser->bufptr
143 # ifndef PL_oldbufptr
144 # define PL_oldbufptr PL_parser->oldbufptr
146 # ifndef PL_lex_inwhat
147 # define PL_lex_inwhat PL_parser->lex_inwhat
149 # ifndef PL_multi_close
150 # define PL_multi_close PL_parser->multi_close
154 # define PL_linestr PL_Ilinestr
157 # define PL_bufptr PL_Ibufptr
159 # ifndef PL_oldbufptr
160 # define PL_oldbufptr PL_Ioldbufptr
162 # ifndef PL_lex_inwhat
163 # define PL_lex_inwhat PL_Ilex_inwhat
165 # ifndef PL_multi_close
166 # define PL_multi_close PL_Imulti_close
170 /* ... Safe version of call_sv() ........................................... */
172 static I32 indirect_call_sv(pTHX_ SV *sv, I32 flags) {
173 #define indirect_call_sv(S, F) indirect_call_sv(aTHX_ (S), (F))
175 PERL_CONTEXT saved_cx;
176 SV *saved_errsv = NULL;
179 if (IN_PERL_COMPILETIME && PL_errors)
180 sv_catsv(PL_errors, ERRSV);
182 saved_errsv = newSVsv(ERRSV);
186 cxix = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
187 /* The last popped context will be reused by call_sv(), but our callers may
188 * still need its previous value. Back it up so that it isn't clobbered. */
189 saved_cx = cxstack[cxix];
191 ret = call_sv(sv, flags | G_EVAL);
193 cxstack[cxix] = saved_cx;
196 /* Discard the old ERRSV, and reuse the variable to temporarily store the
199 sv_setsv(saved_errsv, ERRSV);
201 saved_errsv = newSVsv(ERRSV);
203 /* Immediately flush all errors. */
204 if (IN_PERL_COMPILETIME) {
205 #if XSH_HAS_PERL(5, 10, 0) || defined(PL_parser)
207 ++PL_parser->error_count;
208 #elif defined(PL_error_count)
214 sv_setsv(ERRSV, PL_errors);
215 SvCUR_set(PL_errors, 0);
218 sv_catsv(ERRSV, saved_errsv);
219 SvREFCNT_dec(saved_errsv);
221 } else if (saved_errsv) {
222 /* If IN_PERL_COMPILETIME && PL_errors, then the old ERRSV has already been
223 * added to PL_errors. Otherwise, just restore it to ERRSV, as if no eval
224 * block has ever been executed. */
225 sv_setsv(ERRSV, saved_errsv);
226 SvREFCNT_dec(saved_errsv);
232 /* --- Check functions ----------------------------------------------------- */
234 /* ... op => source position map, continued ................................ */
236 static void indirect_map_store(pTHX_ const OP *o, STRLEN pos, SV *sv, line_t line) {
237 #define indirect_map_store(O, P, N, L) indirect_map_store(aTHX_ (O), (P), (N), (L))
238 indirect_op_info_t *oi;
243 /* No need to check for XSH_CXT.map != NULL because this code path is always
244 * guarded by indirect_hint(). */
246 if (!(oi = ptable_fetch(XSH_CXT.map, o))) {
247 XSH_LOCAL_ALLOC(oi, 1, indirect_op_info_t);
248 ptable_store(XSH_CXT.map, o, oi);
254 s = SvPV_const(sv, len);
260 if (len > oi->size) {
261 XSH_LOCAL_REALLOC(oi->buf, oi->size, len, char);
265 Copy(s, oi->buf, len, char);
272 static const indirect_op_info_t *indirect_map_fetch(pTHX_ const OP *o) {
273 #define indirect_map_fetch(O) indirect_map_fetch(aTHX_ (O))
276 /* No need to check for XSH_CXT.map != NULL because this code path is always
277 * guarded by indirect_hint(). */
279 return ptable_fetch(XSH_CXT.map, o);
282 static void indirect_map_delete(pTHX_ const OP *o) {
283 #define indirect_map_delete(O) indirect_map_delete(aTHX_ (O))
286 if (xsh_is_loaded(&XSH_CXT) && XSH_CXT.map)
287 ptable_delete(XSH_CXT.map, o);
290 /* ... Heuristics for finding a string in the source buffer ................ */
292 static int indirect_find(pTHX_ SV *name_sv, const char *line_bufptr, STRLEN *name_pos) {
293 #define indirect_find(NSV, LBP, NP) indirect_find(aTHX_ (NSV), (LBP), (NP))
294 STRLEN name_len, line_len;
295 const char *name, *name_end;
296 const char *line, *line_end;
299 line = SvPV_const(PL_linestr, line_len);
300 line_end = line + line_len;
302 name = SvPV_const(name_sv, name_len);
303 if (name_len >= 1 && *name == '$') {
306 while (line_bufptr < line_end && *line_bufptr != '$')
308 if (line_bufptr >= line_end)
311 name_end = name + name_len;
315 p = ninstr(p, line_end, name, name_end);
318 if (!isALNUM(p[name_len]))
320 /* p points to a word that has name as prefix, skip the rest of the word */
326 *name_pos = p - line;
331 /* ... ck_const ............................................................ */
333 static OP *(*indirect_old_ck_const)(pTHX_ OP *) = 0;
335 static OP *indirect_ck_const(pTHX_ OP *o) {
336 o = indirect_old_ck_const(aTHX_ o);
338 if (indirect_hint()) {
341 if (SvPOK(sv) && (SvTYPE(sv) >= SVt_PV)) {
345 bufptr = PL_multi_close == '<' ? PL_bufptr : PL_oldbufptr;
347 if (indirect_find(sv, bufptr, &pos)) {
350 /* If the constant is equal to the current package name, try to look for
351 * a "__PACKAGE__" coming before what we got. We only need to check this
352 * when we already had a match because __PACKAGE__ can only appear in
353 * direct method calls ("new __PACKAGE__" is a syntax error). */
356 && len == (STRLEN) HvNAMELEN_get(PL_curstash)
357 && memcmp(SvPVX(sv), HvNAME_get(PL_curstash), len) == 0) {
359 SV *pkg = sv_newmortal();
360 sv_setpvn(pkg, "__PACKAGE__", sizeof("__PACKAGE__")-1);
362 if (indirect_find(pkg, PL_oldbufptr, &pos_pkg) && pos_pkg < pos) {
368 indirect_map_store(o, pos, sv, CopLINE(&PL_compiling));
374 indirect_map_delete(o);
378 /* ... ck_rv2sv ............................................................ */
380 static OP *(*indirect_old_ck_rv2sv)(pTHX_ OP *) = 0;
382 static OP *indirect_ck_rv2sv(pTHX_ OP *o) {
383 if (indirect_hint()) {
384 OP *op = cUNOPo->op_first;
386 const char *name = NULL;
388 OPCODE type = (OPCODE) op->op_type;
393 GV *gv = cGVOPx_gv(op);
399 if ((PL_opargs[type] & OA_CLASS_MASK) == OA_SVOP) {
400 SV *nsv = cSVOPx_sv(op);
401 if (SvPOK(nsv) && (SvTYPE(nsv) >= SVt_PV))
402 name = SvPV_const(nsv, len);
408 sv = sv_2mortal(newSVpvn("$", 1));
409 sv_catpvn_nomg(sv, name, len);
410 if (!indirect_find(sv, PL_oldbufptr, &pos)) {
411 /* If it failed, retry without the current stash */
412 const char *stash = HvNAME_get(PL_curstash);
413 STRLEN stashlen = HvNAMELEN_get(PL_curstash);
415 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
416 || name[stashlen] != ':' || name[stashlen+1] != ':') {
417 /* Failed again ? Try to remove main */
420 if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
421 || name[stashlen] != ':' || name[stashlen+1] != ':')
425 sv_setpvn(sv, "$", 1);
427 sv_catpvn_nomg(sv, name + stashlen, len - stashlen);
428 if (!indirect_find(sv, PL_oldbufptr, &pos))
432 o = indirect_old_ck_rv2sv(aTHX_ o);
434 indirect_map_store(o, pos, sv, CopLINE(&PL_compiling));
439 o = indirect_old_ck_rv2sv(aTHX_ o);
441 indirect_map_delete(o);
445 /* ... ck_padany ........................................................... */
447 static OP *(*indirect_old_ck_padany)(pTHX_ OP *) = 0;
449 static OP *indirect_ck_padany(pTHX_ OP *o) {
450 o = indirect_old_ck_padany(aTHX_ o);
452 if (indirect_hint()) {
454 const char *s = PL_oldbufptr, *t = PL_bufptr - 1;
456 while (s < t && isSPACE(*s)) ++s;
457 if (*s == '$' && ++s <= t) {
458 while (s < t && isSPACE(*s)) ++s;
459 while (s < t && isSPACE(*t)) --t;
460 sv = sv_2mortal(newSVpvn("$", 1));
461 sv_catpvn_nomg(sv, s, t - s + 1);
462 indirect_map_store(o, s - SvPVX_const(PL_linestr),
463 sv, CopLINE(&PL_compiling));
468 indirect_map_delete(o);
472 /* ... ck_scope ............................................................ */
474 static OP *(*indirect_old_ck_scope) (pTHX_ OP *) = 0;
475 static OP *(*indirect_old_ck_lineseq)(pTHX_ OP *) = 0;
477 static OP *indirect_ck_scope(pTHX_ OP *o) {
478 OP *(*old_ck)(pTHX_ OP *) = 0;
480 switch (o->op_type) {
481 case OP_SCOPE: old_ck = indirect_old_ck_scope; break;
482 case OP_LINESEQ: old_ck = indirect_old_ck_lineseq; break;
486 if (indirect_hint()) {
487 indirect_map_store(o, PL_oldbufptr - SvPVX_const(PL_linestr),
488 NULL, CopLINE(&PL_compiling));
492 indirect_map_delete(o);
496 /* We don't need to clean the map entries for leave ops because they can only
497 * be created by mutating from a lineseq. */
499 /* ... ck_method ........................................................... */
501 static OP *(*indirect_old_ck_method)(pTHX_ OP *) = 0;
503 static OP *indirect_ck_method(pTHX_ OP *o) {
504 if (indirect_hint()) {
505 OP *op = cUNOPo->op_first;
507 /* Indirect method call is only possible when the method is a bareword, so
508 * don't trip up on $obj->$meth. */
509 if (op && op->op_type == OP_CONST) {
510 const indirect_op_info_t *oi = indirect_map_fetch(op);
518 sv = sv_2mortal(newSVpvn(oi->buf, oi->len));
520 /* Keep the old line so that we really point to the first line of the
524 o = indirect_old_ck_method(aTHX_ o);
525 /* o may now be a method_named */
527 indirect_map_store(o, pos, sv, line);
533 o = indirect_old_ck_method(aTHX_ o);
535 indirect_map_delete(o);
539 /* ... ck_method_named ..................................................... */
541 /* "use foo/no foo" compiles its call to import/unimport directly to a
542 * method_named op. */
544 static OP *(*indirect_old_ck_method_named)(pTHX_ OP *) = 0;
546 static OP *indirect_ck_method_named(pTHX_ OP *o) {
547 if (indirect_hint()) {
553 if (!SvPOK(sv) || (SvTYPE(sv) < SVt_PV))
555 sv = sv_mortalcopy(sv);
557 if (!indirect_find(sv, PL_oldbufptr, &pos))
559 line = CopLINE(&PL_compiling);
561 o = indirect_old_ck_method_named(aTHX_ o);
563 indirect_map_store(o, pos, sv, line);
568 o = indirect_old_ck_method_named(aTHX_ o);
570 indirect_map_delete(o);
574 /* ... ck_entersub ......................................................... */
576 static OP *(*indirect_old_ck_entersub)(pTHX_ OP *) = 0;
578 static OP *indirect_ck_entersub(pTHX_ OP *o) {
579 SV *code = indirect_hint();
581 o = indirect_old_ck_entersub(aTHX_ o);
584 const indirect_op_info_t *moi, *ooi;
590 lop = (LISTOP *) oop;
591 if (!(lop->op_flags & OPf_KIDS))
594 } while (oop->op_type != OP_PUSHMARK);
595 oop = OpSIBLING(oop);
601 switch (oop->op_type) {
612 if (mop->op_type == OP_METHOD)
613 mop = cUNOPx(mop)->op_first;
614 else if (mop->op_type != OP_METHOD_NAMED)
617 moi = indirect_map_fetch(mop);
621 ooi = indirect_map_fetch(oop);
625 /* When positions are identical, the method and the object must have the
626 * same name. But it also means that it is an indirect call, as "foo->foo"
627 * results in different positions. */
628 if ( moi->line < ooi->line
629 || (moi->line == ooi->line && moi->pos <= ooi->pos)) {
637 file = sv_2mortal(newSVpv(CopFILE(&PL_compiling), 0));
639 file = sv_mortalcopy(CopFILESV(&PL_compiling));
644 mPUSHp(ooi->buf, ooi->len);
645 mPUSHp(moi->buf, moi->len);
650 indirect_call_sv(code, G_VOID);
663 /* --- Module setup/teardown ----------------------------------------------- */
665 static void xsh_user_global_setup(pTHX) {
666 xsh_ck_replace(OP_CONST, indirect_ck_const, &indirect_old_ck_const);
667 xsh_ck_replace(OP_RV2SV, indirect_ck_rv2sv, &indirect_old_ck_rv2sv);
668 xsh_ck_replace(OP_PADANY, indirect_ck_padany, &indirect_old_ck_padany);
669 xsh_ck_replace(OP_SCOPE, indirect_ck_scope, &indirect_old_ck_scope);
670 xsh_ck_replace(OP_LINESEQ, indirect_ck_scope, &indirect_old_ck_lineseq);
672 xsh_ck_replace(OP_METHOD, indirect_ck_method,
673 &indirect_old_ck_method);
674 xsh_ck_replace(OP_METHOD_NAMED, indirect_ck_method_named,
675 &indirect_old_ck_method_named);
676 xsh_ck_replace(OP_ENTERSUB, indirect_ck_entersub,
677 &indirect_old_ck_entersub);
682 static void xsh_user_local_setup(pTHX_ xsh_user_cxt_t *cxt) {
685 stash = gv_stashpvn(XSH_PACKAGE, XSH_PACKAGE_LEN, 1);
686 newCONSTSUB(stash, "I_THREADSAFE", newSVuv(XSH_THREADSAFE));
687 newCONSTSUB(stash, "I_FORKSAFE", newSVuv(XSH_FORKSAFE));
689 cxt->map = ptable_new(32);
690 cxt->global_code = NULL;
695 static void xsh_user_local_teardown(pTHX_ xsh_user_cxt_t *cxt) {
696 SvREFCNT_dec(cxt->global_code);
697 cxt->global_code = NULL;
699 ptable_free(cxt->map);
705 static void xsh_user_global_teardown(pTHX) {
706 xsh_ck_restore(OP_CONST, &indirect_old_ck_const);
707 xsh_ck_restore(OP_RV2SV, &indirect_old_ck_rv2sv);
708 xsh_ck_restore(OP_PADANY, &indirect_old_ck_padany);
709 xsh_ck_restore(OP_SCOPE, &indirect_old_ck_scope);
710 xsh_ck_restore(OP_LINESEQ, &indirect_old_ck_lineseq);
712 xsh_ck_restore(OP_METHOD, &indirect_old_ck_method);
713 xsh_ck_restore(OP_METHOD_NAMED, &indirect_old_ck_method_named);
714 xsh_ck_restore(OP_ENTERSUB, &indirect_old_ck_entersub);
719 /* --- XS ------------------------------------------------------------------ */
721 MODULE = indirect PACKAGE = indirect
739 #endif /* XSH_THREADSAFE */
747 else if (SvROK(code))
749 RETVAL = xsh_hints_tag(code);
759 else if (SvROK(code))
763 SvREFCNT_dec(XSH_CXT.global_code);
764 XSH_CXT.global_code = SvREFCNT_inc(code);