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 #ifndef LT_MULTIPLICITY
49 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
50 # define LT_MULTIPLICITY 1
52 # define LT_MULTIPLICITY 0
57 # define tTHX PerlInterpreter*
60 #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))
61 # define LT_THREADSAFE 1
63 # define MY_CXT_CLONE \
65 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
66 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
67 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
70 # define LT_THREADSAFE 0
72 # define dMY_CXT dNOOP
74 # define MY_CXT lt_globaldata
76 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
78 # define MY_CXT_INIT NOOP
80 # define MY_CXT_CLONE NOOP
91 /* --- Helpers ------------------------------------------------------------- */
93 /* ... Thread-safe hints ................................................... */
95 #if LT_WORKAROUND_REQUIRE_PROPAGATION
102 #define LT_HINT_STRUCT 1
104 #define LT_HINT_CODE(H) ((H)->code)
106 #define LT_HINT_FREE(H) { \
107 lt_hint_t *h = (H); \
108 SvREFCNT_dec(h->code); \
109 PerlMemShared_free(h); \
112 #else /* LT_WORKAROUND_REQUIRE_PROPAGATION */
114 typedef SV lt_hint_t;
116 #define LT_HINT_STRUCT 0
118 #define LT_HINT_CODE(H) (H)
120 #define LT_HINT_FREE(H) SvREFCNT_dec(H);
122 #endif /* !LT_WORKAROUND_REQUIRE_PROPAGATION */
126 #define PTABLE_NAME ptable_hints
127 #define PTABLE_VAL_FREE(V) LT_HINT_FREE(V)
136 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
137 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
139 #endif /* LT_THREADSAFE */
141 /* ... "Seen" pointer table ................................................ */
145 #define PTABLE_NAME ptable_seen
146 #define PTABLE_VAL_FREE(V) NOOP
150 #endif /* !LT_HAS_RPEEP */
152 /* ... Global data ......................................................... */
154 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
158 ptable *tbl; /* It really is a ptable_hints */
162 ptable *seen; /* It really is a ptable_seen */
169 /* ... Cloning global data ................................................. */
175 #if LT_HAS_PERL(5, 13, 2)
176 CLONE_PARAMS *params;
180 } lt_ptable_clone_ud;
182 #if LT_HAS_PERL(5, 13, 2)
183 # define lt_ptable_clone_ud_init(U, T, O) \
185 (U).params = Perl_clone_params_new((O), aTHX)
186 # define lt_ptable_clone_ud_deinit(U) Perl_clone_params_del((U).params)
187 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), (U)->params))
189 # define lt_ptable_clone_ud_init(U, T, O) \
191 (U).params.stashes = newAV(); \
192 (U).params.flags = 0; \
193 (U).params.proto_perl = (O)
194 # define lt_ptable_clone_ud_deinit(U) SvREFCNT_dec((U).params.stashes)
195 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), &((U)->params)))
198 STATIC void lt_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
199 lt_ptable_clone_ud *ud = ud_;
200 lt_hint_t *h1 = ent->val;
205 h2 = PerlMemShared_malloc(sizeof *h2);
206 h2->code = lt_dup_inc(h1->code, ud);
207 #if LT_WORKAROUND_REQUIRE_PROPAGATION
208 h2->require_tag = PTR2IV(lt_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
211 #else /* LT_HINT_STRUCT */
213 h2 = lt_dup_inc(h1, ud);
215 #endif /* !LT_HINT_STRUCT */
217 ptable_hints_store(ud->tbl, ent->key, h2);
222 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
225 ptable_hints_free(MY_CXT.tbl);
227 ptable_seen_free(MY_CXT.seen);
228 #endif /* !LT_HAS_RPEEP */
231 #endif /* LT_THREADSAFE */
233 /* ... Hint tags ........................................................... */
235 #if LT_WORKAROUND_REQUIRE_PROPAGATION
237 STATIC IV lt_require_tag(pTHX) {
238 #define lt_require_tag() lt_require_tag(aTHX)
239 const CV *cv, *outside;
244 /* If for some reason the pragma is operational at run-time, try to discover
245 * the current cv in use. */
248 for (si = PL_curstackinfo; si; si = si->si_prev) {
251 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
252 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
254 switch (CxTYPE(cx)) {
257 /* The propagation workaround is only needed up to 5.10.0 and at that
258 * time format and sub contexts were still identical. And even later the
259 * cv members offsets should have been kept the same. */
261 goto get_enclosing_cv;
263 cv = cx->blk_eval.cv;
264 goto get_enclosing_cv;
275 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
281 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
283 STATIC SV *lt_tag(pTHX_ SV *value) {
284 #define lt_tag(V) lt_tag(aTHX_ (V))
290 if (SvTYPE(value) >= SVt_PVCV) {
292 SvREFCNT_inc_simple_NN(code);
297 h = PerlMemShared_malloc(sizeof *h);
299 # if LT_WORKAROUND_REQUIRE_PROPAGATION
300 h->require_tag = lt_require_tag();
301 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
302 #else /* LT_HINT_STRUCT */
304 #endif /* !LT_HINT_STRUCT */
309 /* We only need for the key to be an unique tag for looking up the value later
310 * Allocated memory provides convenient unique identifiers, so that's why we
311 * use the hint as the key itself. */
312 ptable_hints_store(MY_CXT.tbl, h, h);
314 #endif /* LT_THREADSAFE */
316 return newSViv(PTR2IV(h));
319 STATIC SV *lt_detag(pTHX_ const SV *hint) {
320 #define lt_detag(H) lt_detag(aTHX_ (H))
326 if (!(hint && SvIOK(hint)))
329 h = INT2PTR(lt_hint_t *, SvIVX(hint));
331 h = ptable_fetch(MY_CXT.tbl, h);
332 #endif /* LT_THREADSAFE */
333 #if LT_WORKAROUND_REQUIRE_PROPAGATION
334 if (lt_require_tag() != h->require_tag)
336 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
338 return LT_HINT_CODE(h);
341 STATIC U32 lt_hash = 0;
343 STATIC SV *lt_hint(pTHX) {
344 #define lt_hint() lt_hint(aTHX)
346 #ifdef cop_hints_fetch_pvn
347 hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__, lt_hash,0);
348 #elif LT_HAS_PERL(5, 9, 5)
349 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
351 __PACKAGE__, __PACKAGE_LEN__,
355 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
360 return lt_detag(hint);
363 /* ... op => info map ...................................................... */
365 #define PTABLE_NAME ptable_map
366 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
370 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
371 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
373 STATIC ptable *lt_op_map = NULL;
377 STATIC perl_mutex lt_op_map_mutex;
379 #define LT_LOCK(M) MUTEX_LOCK(M)
380 #define LT_UNLOCK(M) MUTEX_UNLOCK(M)
382 #else /* USE_ITHREADS */
387 #endif /* !USE_ITHREADS */
391 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
393 #else /* MULTIPLICITY */
397 #endif /* !MULTIPLICITY */
398 OP *(*old_pp_padsv)(pTHX);
401 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
402 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
405 LT_LOCK(<_op_map_mutex);
407 if (!(oi = ptable_fetch(lt_op_map, o))) {
408 oi = PerlMemShared_malloc(sizeof *oi);
409 ptable_map_store(lt_op_map, o, oi);
413 #else /* MULTIPLICITY */
415 SvREFCNT_dec(oi->orig_pkg);
416 SvREFCNT_dec(oi->type_pkg);
417 SvREFCNT_dec(oi->type_meth);
418 #endif /* !MULTIPLICITY */
423 STRLEN op_len = SvCUR(orig_pkg);
424 STRLEN tp_len = SvCUR(type_pkg);
425 STRLEN tm_len = SvCUR(type_meth);
426 STRLEN new_buf_size = op_len + tp_len + tm_len;
428 if (new_buf_size > oi->buf_size) {
429 PerlMemShared_free(oi->buf);
430 oi->buf = PerlMemShared_malloc(new_buf_size);
431 oi->buf_size = new_buf_size;
434 Copy(SvPVX(orig_pkg), buf, op_len, char);
436 Copy(SvPVX(type_pkg), buf, tp_len, char);
438 Copy(SvPVX(type_meth), buf, tm_len, char);
439 oi->orig_pkg_len = op_len;
440 oi->type_pkg_len = tp_len;
441 oi->type_meth_len = tm_len;
442 SvREFCNT_dec(orig_pkg);
443 SvREFCNT_dec(type_pkg);
444 SvREFCNT_dec(type_meth);
446 #else /* MULTIPLICITY */
447 oi->orig_pkg = orig_pkg;
448 oi->type_pkg = type_pkg;
449 oi->type_meth = type_meth;
450 #endif /* !MULTIPLICITY */
452 oi->old_pp_padsv = old_pp_padsv;
454 LT_UNLOCK(<_op_map_mutex);
457 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
458 const lt_op_info *val;
460 LT_LOCK(<_op_map_mutex);
462 val = ptable_fetch(lt_op_map, o);
468 LT_UNLOCK(<_op_map_mutex);
473 STATIC void lt_map_delete(pTHX_ const OP *o) {
474 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
475 LT_LOCK(<_op_map_mutex);
477 ptable_map_delete(lt_op_map, o);
479 LT_UNLOCK(<_op_map_mutex);
482 /* --- Hooks --------------------------------------------------------------- */
484 /* ... Our pp_padsv ........................................................ */
486 STATIC OP *lt_pp_padsv(pTHX) {
489 if (lt_map_fetch(PL_op, &oi)) {
490 PADOFFSET targ = PL_op->op_targ;
491 SV *sv = PAD_SVl(targ);
494 SV *orig_pkg, *type_pkg, *type_meth;
503 STRLEN op_len = oi.orig_pkg_len, tp_len = oi.type_pkg_len;
505 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
506 SvREADONLY_on(orig_pkg);
508 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
509 SvREADONLY_on(type_pkg);
511 type_meth = sv_2mortal(newSVpvn(buf, oi.type_meth_len));
512 SvREADONLY_on(type_meth);
514 #else /* MULTIPLICITY */
515 orig_pkg = oi.orig_pkg;
516 type_pkg = oi.type_pkg;
517 type_meth = oi.type_meth;
518 #endif /* !MULTIPLICITY */
527 items = call_sv(type_meth, G_ARRAY | G_METHOD);
537 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
545 return oi.old_pp_padsv(aTHX);
548 return PL_op->op_ppaddr(aTHX);
551 /* ... Our ck_pad{any,sv} .................................................. */
553 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
554 * function, but are instead manually mutated from a padany. So we store
555 * the op entry in the op map in the padany check function, and we set their
556 * op_ppaddr member in our peephole optimizer replacement below. */
558 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
560 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
564 o = lt_old_ck_padany(aTHX_ o);
566 stash = PL_in_my_stash;
567 if (stash && (code = lt_hint())) {
569 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
570 SV *orig_meth = MY_CXT.default_meth;
572 SV *type_meth = NULL;
577 SvREADONLY_on(orig_pkg);
588 items = call_sv(code, G_ARRAY);
592 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
594 SvREFCNT_dec(orig_pkg);
603 type_meth = newSVsv(rsv);
604 SvREADONLY_on(type_meth);
609 type_pkg = newSVsv(rsv);
610 SvREADONLY_on(type_pkg);
620 SvREFCNT_inc(orig_pkg);
624 type_meth = orig_meth;
625 SvREFCNT_inc(orig_meth);
628 lt_map_store(o, orig_pkg, type_pkg, type_meth, o->op_ppaddr);
637 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
639 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
642 return lt_old_ck_padsv(aTHX_ o);
645 /* ... Our peephole optimizer .............................................. */
647 STATIC peep_t lt_old_peep = 0; /* This is actually the rpeep past 5.13.5 */
650 # define LT_PEEP_REC_PROTO STATIC void lt_peep_rec(pTHX_ OP *o, ptable *seen)
651 #else /* !LT_HAS_RPEEP */
652 # define LT_PEEP_REC_PROTO STATIC void lt_peep_rec(pTHX_ OP *o)
653 #endif /* LT_HAS_RPEEP */
658 # define lt_peep_rec(O) lt_peep_rec(aTHX_ (O), seen)
659 #else /* !LT_HAS_RPEEP */
660 # define lt_peep_rec(O) lt_peep_rec(aTHX_ (O))
661 #endif /* LT_HAS_RPEEP */
664 if (ptable_fetch(seen, o))
668 for (; o; o = o->op_next) {
669 lt_op_info *oi = NULL;
672 ptable_seen_store(seen, o, o);
674 switch (o->op_type) {
676 if (o->op_ppaddr != lt_pp_padsv && o->op_private & OPpLVAL_INTRO) {
677 LT_LOCK(<_op_map_mutex);
678 oi = ptable_fetch(lt_op_map, o);
680 oi->old_pp_padsv = o->op_ppaddr;
681 o->op_ppaddr = lt_pp_padsv;
683 LT_UNLOCK(<_op_map_mutex);
695 # if LT_HAS_PERL(5, 10, 0)
700 lt_peep_rec(cLOGOPo->op_other);
704 lt_peep_rec(cLOOPo->op_redoop);
705 lt_peep_rec(cLOOPo->op_nextop);
706 lt_peep_rec(cLOOPo->op_lastop);
708 # if LT_HAS_PERL(5, 9, 5)
710 lt_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
716 lt_peep_rec(cPMOPo->op_pmreplstart);
719 #endif /* !LT_HAS_RPEEP */
726 STATIC void lt_peep(pTHX_ OP *o) {
729 ptable *seen = MY_CXT.seen;
731 ptable_seen_clear(seen);
732 #endif /* !LT_HAS_RPEEP */
734 lt_old_peep(aTHX_ o);
738 /* --- Interpreter setup/teardown ------------------------------------------ */
741 STATIC U32 lt_initialized = 0;
743 STATIC void lt_teardown(pTHX_ void *root) {
755 ptable_hints_free(MY_CXT.tbl);
758 ptable_seen_free(MY_CXT.seen);
760 SvREFCNT_dec(MY_CXT.default_meth);
763 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_old_ck_padany);
764 lt_old_ck_padany = 0;
765 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_old_ck_padsv);
769 PL_rpeepp = lt_old_peep;
771 PL_peepp = lt_old_peep;
778 STATIC void lt_setup(pTHX) {
779 #define lt_setup() lt_setup(aTHX)
786 MY_CXT.tbl = ptable_new();
790 MY_CXT.seen = ptable_new();
792 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
793 SvREADONLY_on(MY_CXT.default_meth);
796 lt_old_ck_padany = PL_check[OP_PADANY];
797 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
798 lt_old_ck_padsv = PL_check[OP_PADSV];
799 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_ck_padsv);
802 lt_old_peep = PL_rpeepp;
805 lt_old_peep = PL_peepp;
810 call_atexit(lt_teardown, aTHX);
812 call_atexit(lt_teardown, NULL);
818 STATIC U32 lt_booted = 0;
820 /* --- XS ------------------------------------------------------------------ */
822 MODULE = Lexical::Types PACKAGE = Lexical::Types
831 lt_op_map = ptable_new();
833 MUTEX_INIT(<_op_map_mutex);
836 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
838 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
839 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
855 SV *cloned_default_meth;
859 lt_ptable_clone_ud ud;
863 lt_ptable_clone_ud_init(ud, t, MY_CXT.owner);
864 ptable_walk(MY_CXT.tbl, lt_ptable_clone, &ud);
865 cloned_default_meth = lt_dup_inc(MY_CXT.default_meth, &ud);
866 lt_ptable_clone_ud_deinit(ud);
879 MY_CXT.default_meth = cloned_default_meth;
881 reap(3, lt_thread_cleanup, NULL);
890 RETVAL = lt_tag(value);