1 /* This file is part of the Lexical-Types Perl module.
2 * See http://search.cpan.org/dist/Lexical-Types/ */
4 #define PERL_NO_GET_CONTEXT
9 #define __PACKAGE__ "Lexical::Types"
10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
12 /* --- Compatibility wrappers ---------------------------------------------- */
14 #define LT_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
16 #if LT_HAS_PERL(5, 10, 0) || defined(PL_parser)
17 # ifndef PL_in_my_stash
18 # define PL_in_my_stash PL_parser->in_my_stash
21 # ifndef PL_in_my_stash
22 # define PL_in_my_stash PL_Iin_my_stash
26 #ifndef LT_WORKAROUND_REQUIRE_PROPAGATION
27 # define LT_WORKAROUND_REQUIRE_PROPAGATION !LT_HAS_PERL(5, 10, 1)
31 # define LT_HAS_RPEEP LT_HAS_PERL(5, 13, 5)
35 # define HvNAME_get(H) HvNAME(H)
39 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
42 #ifndef SvREFCNT_inc_simple_NN
43 # define SvREFCNT_inc_simple_NN SvREFCNT_inc
46 /* ... Thread safety and multiplicity ...................................... */
48 /* Safe unless stated otherwise in Makefile.PL */
50 # define LT_FORKSAFE 1
53 #ifndef LT_MULTIPLICITY
54 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
55 # define LT_MULTIPLICITY 1
57 # define LT_MULTIPLICITY 0
62 # define tTHX PerlInterpreter*
65 #if LT_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))
66 # define LT_THREADSAFE 1
68 # define MY_CXT_CLONE \
70 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
71 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
72 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
75 # define LT_THREADSAFE 0
77 # define dMY_CXT dNOOP
79 # define MY_CXT lt_globaldata
81 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
83 # define MY_CXT_INIT NOOP
85 # define MY_CXT_CLONE NOOP
96 /* --- Helpers ------------------------------------------------------------- */
98 /* ... Thread-safe hints ................................................... */
100 #if LT_WORKAROUND_REQUIRE_PROPAGATION
107 #define LT_HINT_STRUCT 1
109 #define LT_HINT_CODE(H) ((H)->code)
111 #define LT_HINT_FREE(H) { \
112 lt_hint_t *h = (H); \
113 SvREFCNT_dec(h->code); \
114 PerlMemShared_free(h); \
117 #else /* LT_WORKAROUND_REQUIRE_PROPAGATION */
119 typedef SV lt_hint_t;
121 #define LT_HINT_STRUCT 0
123 #define LT_HINT_CODE(H) (H)
125 #define LT_HINT_FREE(H) SvREFCNT_dec(H);
127 #endif /* !LT_WORKAROUND_REQUIRE_PROPAGATION */
131 #define PTABLE_NAME ptable_hints
132 #define PTABLE_VAL_FREE(V) LT_HINT_FREE(V)
141 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
142 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
144 #endif /* LT_THREADSAFE */
146 /* ... "Seen" pointer table ................................................ */
150 #define PTABLE_NAME ptable_seen
151 #define PTABLE_VAL_FREE(V) NOOP
155 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
156 #define ptable_seen_store(T, K, V) ptable_seen_store(aPTBLMS_ (T), (K), (V))
157 #define ptable_seen_clear(T) ptable_seen_clear(aPTBLMS_ (T))
158 #define ptable_seen_free(T) ptable_seen_free(aPTBLMS_ (T))
160 #endif /* !LT_HAS_RPEEP */
162 /* ... Global data ......................................................... */
164 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
168 ptable *tbl; /* It really is a ptable_hints */
172 ptable *seen; /* It really is a ptable_seen */
179 /* ... Cloning global data ................................................. */
185 #if LT_HAS_PERL(5, 13, 2)
186 CLONE_PARAMS *params;
190 } lt_ptable_clone_ud;
192 #if LT_HAS_PERL(5, 13, 2)
193 # define lt_ptable_clone_ud_init(U, T, O) \
195 (U).params = Perl_clone_params_new((O), aTHX)
196 # define lt_ptable_clone_ud_deinit(U) Perl_clone_params_del((U).params)
197 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), (U)->params))
199 # define lt_ptable_clone_ud_init(U, T, O) \
201 (U).params.stashes = newAV(); \
202 (U).params.flags = 0; \
203 (U).params.proto_perl = (O)
204 # define lt_ptable_clone_ud_deinit(U) SvREFCNT_dec((U).params.stashes)
205 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), &((U)->params)))
208 STATIC void lt_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
209 lt_ptable_clone_ud *ud = ud_;
210 lt_hint_t *h1 = ent->val;
215 h2 = PerlMemShared_malloc(sizeof *h2);
216 h2->code = lt_dup_inc(h1->code, ud);
217 #if LT_WORKAROUND_REQUIRE_PROPAGATION
218 h2->require_tag = PTR2IV(lt_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
221 #else /* LT_HINT_STRUCT */
223 h2 = lt_dup_inc(h1, ud);
225 #endif /* !LT_HINT_STRUCT */
227 ptable_hints_store(ud->tbl, ent->key, h2);
232 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
235 ptable_hints_free(MY_CXT.tbl);
237 ptable_seen_free(MY_CXT.seen);
238 #endif /* !LT_HAS_RPEEP */
241 #endif /* LT_THREADSAFE */
243 /* ... Hint tags ........................................................... */
245 #if LT_WORKAROUND_REQUIRE_PROPAGATION
247 STATIC IV lt_require_tag(pTHX) {
248 #define lt_require_tag() lt_require_tag(aTHX)
249 const CV *cv, *outside;
254 /* If for some reason the pragma is operational at run-time, try to discover
255 * the current cv in use. */
258 for (si = PL_curstackinfo; si; si = si->si_prev) {
261 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
262 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
264 switch (CxTYPE(cx)) {
267 /* The propagation workaround is only needed up to 5.10.0 and at that
268 * time format and sub contexts were still identical. And even later the
269 * cv members offsets should have been kept the same. */
271 goto get_enclosing_cv;
273 cv = cx->blk_eval.cv;
274 goto get_enclosing_cv;
285 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
291 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
293 STATIC SV *lt_tag(pTHX_ SV *value) {
294 #define lt_tag(V) lt_tag(aTHX_ (V))
300 if (SvTYPE(value) >= SVt_PVCV) {
302 SvREFCNT_inc_simple_NN(code);
307 h = PerlMemShared_malloc(sizeof *h);
309 # if LT_WORKAROUND_REQUIRE_PROPAGATION
310 h->require_tag = lt_require_tag();
311 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
312 #else /* LT_HINT_STRUCT */
314 #endif /* !LT_HINT_STRUCT */
319 /* We only need for the key to be an unique tag for looking up the value later
320 * Allocated memory provides convenient unique identifiers, so that's why we
321 * use the hint as the key itself. */
322 ptable_hints_store(MY_CXT.tbl, h, h);
324 #endif /* LT_THREADSAFE */
326 return newSViv(PTR2IV(h));
329 STATIC SV *lt_detag(pTHX_ const SV *hint) {
330 #define lt_detag(H) lt_detag(aTHX_ (H))
336 if (!(hint && SvIOK(hint)))
339 h = INT2PTR(lt_hint_t *, SvIVX(hint));
341 h = ptable_fetch(MY_CXT.tbl, h);
342 #endif /* LT_THREADSAFE */
343 #if LT_WORKAROUND_REQUIRE_PROPAGATION
344 if (lt_require_tag() != h->require_tag)
346 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
348 return LT_HINT_CODE(h);
351 STATIC U32 lt_hash = 0;
353 STATIC SV *lt_hint(pTHX) {
354 #define lt_hint() lt_hint(aTHX)
356 #ifdef cop_hints_fetch_pvn
357 hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__, lt_hash,0);
358 #elif LT_HAS_PERL(5, 9, 5)
359 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
361 __PACKAGE__, __PACKAGE_LEN__,
365 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
370 return lt_detag(hint);
373 /* ... op => info map ...................................................... */
375 #define PTABLE_NAME ptable_map
376 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
380 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
381 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
382 #define ptable_map_delete(T, K) ptable_map_delete(aPTBLMS_ (T), (K))
384 STATIC ptable *lt_op_map = NULL;
388 STATIC perl_mutex lt_op_map_mutex;
390 #define LT_LOCK(M) MUTEX_LOCK(M)
391 #define LT_UNLOCK(M) MUTEX_UNLOCK(M)
393 #else /* USE_ITHREADS */
398 #endif /* !USE_ITHREADS */
402 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
404 #else /* MULTIPLICITY */
408 #endif /* !MULTIPLICITY */
409 OP *(*old_pp_padsv)(pTHX);
412 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
413 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
416 LT_LOCK(<_op_map_mutex);
418 if (!(oi = ptable_fetch(lt_op_map, o))) {
419 oi = PerlMemShared_malloc(sizeof *oi);
420 ptable_map_store(lt_op_map, o, oi);
424 #else /* MULTIPLICITY */
426 SvREFCNT_dec(oi->orig_pkg);
427 SvREFCNT_dec(oi->type_pkg);
428 SvREFCNT_dec(oi->type_meth);
429 #endif /* !MULTIPLICITY */
434 STRLEN op_len = SvCUR(orig_pkg);
435 STRLEN tp_len = SvCUR(type_pkg);
436 STRLEN tm_len = SvCUR(type_meth);
437 STRLEN new_buf_size = op_len + tp_len + tm_len;
439 if (new_buf_size > oi->buf_size) {
440 PerlMemShared_free(oi->buf);
441 oi->buf = PerlMemShared_malloc(new_buf_size);
442 oi->buf_size = new_buf_size;
445 Copy(SvPVX(orig_pkg), buf, op_len, char);
447 Copy(SvPVX(type_pkg), buf, tp_len, char);
449 Copy(SvPVX(type_meth), buf, tm_len, char);
450 oi->orig_pkg_len = op_len;
451 oi->type_pkg_len = tp_len;
452 oi->type_meth_len = tm_len;
453 SvREFCNT_dec(orig_pkg);
454 SvREFCNT_dec(type_pkg);
455 SvREFCNT_dec(type_meth);
457 #else /* MULTIPLICITY */
458 oi->orig_pkg = orig_pkg;
459 oi->type_pkg = type_pkg;
460 oi->type_meth = type_meth;
461 #endif /* !MULTIPLICITY */
463 oi->old_pp_padsv = old_pp_padsv;
465 LT_UNLOCK(<_op_map_mutex);
468 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
469 const lt_op_info *val;
471 LT_LOCK(<_op_map_mutex);
473 val = ptable_fetch(lt_op_map, o);
479 LT_UNLOCK(<_op_map_mutex);
484 STATIC void lt_map_delete(pTHX_ const OP *o) {
485 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
486 LT_LOCK(<_op_map_mutex);
488 ptable_map_delete(lt_op_map, o);
490 LT_UNLOCK(<_op_map_mutex);
493 /* --- Hooks --------------------------------------------------------------- */
495 /* ... Our pp_padsv ........................................................ */
497 STATIC OP *lt_pp_padsv(pTHX) {
500 if (lt_map_fetch(PL_op, &oi)) {
501 SV *orig_pkg, *type_pkg, *type_meth;
511 STRLEN op_len = oi.orig_pkg_len, tp_len = oi.type_pkg_len;
513 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
514 SvREADONLY_on(orig_pkg);
516 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
517 SvREADONLY_on(type_pkg);
519 type_meth = sv_2mortal(newSVpvn(buf, oi.type_meth_len));
520 SvREADONLY_on(type_meth);
522 #else /* MULTIPLICITY */
523 orig_pkg = oi.orig_pkg;
524 type_pkg = oi.type_pkg;
525 type_meth = oi.type_meth;
526 #endif /* !MULTIPLICITY */
535 items = call_sv(type_meth, G_ARRAY | G_METHOD);
542 sv_setsv(TARG, POPs);
545 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
552 return oi.old_pp_padsv(aTHX);
555 return PL_op->op_ppaddr(aTHX);
558 /* ... Our ck_pad{any,sv} .................................................. */
560 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
561 * function, but are instead manually mutated from a padany. So we store
562 * the op entry in the op map in the padany check function, and we set their
563 * op_ppaddr member in our peephole optimizer replacement below. */
565 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
567 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
571 o = lt_old_ck_padany(aTHX_ o);
573 stash = PL_in_my_stash;
574 if (stash && (code = lt_hint())) {
576 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
577 SV *orig_meth = MY_CXT.default_meth;
579 SV *type_meth = NULL;
584 SvREADONLY_on(orig_pkg);
595 items = call_sv(code, G_ARRAY);
599 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
601 SvREFCNT_dec(orig_pkg);
610 type_meth = newSVsv(rsv);
611 SvREADONLY_on(type_meth);
616 type_pkg = newSVsv(rsv);
617 SvREADONLY_on(type_pkg);
627 SvREFCNT_inc(orig_pkg);
631 type_meth = orig_meth;
632 SvREFCNT_inc(orig_meth);
635 lt_map_store(o, orig_pkg, type_pkg, type_meth, o->op_ppaddr);
644 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
646 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
649 return lt_old_ck_padsv(aTHX_ o);
652 /* ... Our peephole optimizer .............................................. */
654 STATIC peep_t lt_old_peep = 0; /* This is actually the rpeep past 5.13.5 */
657 # define LT_PEEP_REC_PROTO STATIC void lt_peep_rec(pTHX_ OP *o, ptable *seen)
658 #else /* !LT_HAS_RPEEP */
659 # define LT_PEEP_REC_PROTO STATIC void lt_peep_rec(pTHX_ OP *o)
660 #endif /* LT_HAS_RPEEP */
665 # define lt_peep_rec(O) lt_peep_rec(aTHX_ (O), seen)
666 #else /* !LT_HAS_RPEEP */
667 # define lt_peep_rec(O) lt_peep_rec(aTHX_ (O))
668 #endif /* LT_HAS_RPEEP */
671 if (ptable_fetch(seen, o))
675 for (; o; o = o->op_next) {
676 lt_op_info *oi = NULL;
679 ptable_seen_store(seen, o, o);
681 switch (o->op_type) {
683 if (o->op_ppaddr != lt_pp_padsv && o->op_private & OPpLVAL_INTRO) {
684 LT_LOCK(<_op_map_mutex);
685 oi = ptable_fetch(lt_op_map, o);
687 oi->old_pp_padsv = o->op_ppaddr;
688 o->op_ppaddr = lt_pp_padsv;
690 LT_UNLOCK(<_op_map_mutex);
702 # if LT_HAS_PERL(5, 10, 0)
707 lt_peep_rec(cLOGOPo->op_other);
711 lt_peep_rec(cLOOPo->op_redoop);
712 lt_peep_rec(cLOOPo->op_nextop);
713 lt_peep_rec(cLOOPo->op_lastop);
715 # if LT_HAS_PERL(5, 9, 5)
717 lt_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
723 lt_peep_rec(cPMOPo->op_pmreplstart);
726 #endif /* !LT_HAS_RPEEP */
733 STATIC void lt_peep(pTHX_ OP *o) {
736 ptable *seen = MY_CXT.seen;
738 ptable_seen_clear(seen);
739 #endif /* !LT_HAS_RPEEP */
741 lt_old_peep(aTHX_ o);
745 /* --- Interpreter setup/teardown ------------------------------------------ */
748 STATIC U32 lt_initialized = 0;
750 STATIC void lt_teardown(pTHX_ void *root) {
762 ptable_hints_free(MY_CXT.tbl);
765 ptable_seen_free(MY_CXT.seen);
767 SvREFCNT_dec(MY_CXT.default_meth);
770 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_old_ck_padany);
771 lt_old_ck_padany = 0;
772 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_old_ck_padsv);
776 PL_rpeepp = lt_old_peep;
778 PL_peepp = lt_old_peep;
785 STATIC void lt_setup(pTHX) {
786 #define lt_setup() lt_setup(aTHX)
793 MY_CXT.tbl = ptable_new();
797 MY_CXT.seen = ptable_new();
799 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
800 SvREADONLY_on(MY_CXT.default_meth);
803 lt_old_ck_padany = PL_check[OP_PADANY];
804 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
805 lt_old_ck_padsv = PL_check[OP_PADSV];
806 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_ck_padsv);
809 lt_old_peep = PL_rpeepp;
812 lt_old_peep = PL_peepp;
817 call_atexit(lt_teardown, aTHX);
819 call_atexit(lt_teardown, NULL);
825 STATIC U32 lt_booted = 0;
827 /* --- XS ------------------------------------------------------------------ */
829 MODULE = Lexical::Types PACKAGE = Lexical::Types
838 lt_op_map = ptable_new();
840 MUTEX_INIT(<_op_map_mutex);
843 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
845 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
846 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
847 newCONSTSUB(stash, "LT_FORKSAFE", newSVuv(LT_FORKSAFE));
863 SV *cloned_default_meth;
867 lt_ptable_clone_ud ud;
871 lt_ptable_clone_ud_init(ud, t, MY_CXT.owner);
872 ptable_walk(MY_CXT.tbl, lt_ptable_clone, &ud);
873 cloned_default_meth = lt_dup_inc(MY_CXT.default_meth, &ud);
874 lt_ptable_clone_ud_deinit(ud);
887 MY_CXT.default_meth = cloned_default_meth;
889 reap(3, lt_thread_cleanup, NULL);
898 RETVAL = lt_tag(value);