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_void_NN
43 # define SvREFCNT_inc_simple_void_NN(S) ((void) SvREFCNT_inc(S))
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 #if defined(OP_CHECK_MUTEX_LOCK) && defined(OP_CHECK_MUTEX_UNLOCK)
97 # define LT_CHECK_MUTEX_LOCK OP_CHECK_MUTEX_LOCK
98 # define LT_CHECK_MUTEX_UNLOCK OP_CHECK_MUTEX_UNLOCK
100 # define LT_CHECK_MUTEX_LOCK OP_REFCNT_LOCK
101 # define LT_CHECK_MUTEX_UNLOCK OP_REFCNT_UNLOCK
104 typedef OP *(*lt_ck_t)(pTHX_ OP *);
106 #ifdef wrap_op_checker
108 # define lt_ck_replace(T, NC, OCP) wrap_op_checker((T), (NC), (OCP))
112 STATIC void lt_ck_replace(pTHX_ OPCODE type, lt_ck_t new_ck, lt_ck_t *old_ck_p){
113 #define lt_ck_replace(T, NC, OCP) lt_ck_replace(aTHX_ (T), (NC), (OCP))
116 *old_ck_p = PL_check[type];
117 PL_check[type] = new_ck;
119 LT_CHECK_MUTEX_UNLOCK;
124 STATIC void lt_ck_restore(pTHX_ OPCODE type, lt_ck_t *old_ck_p) {
125 #define lt_ck_restore(T, OCP) lt_ck_restore(aTHX_ (T), (OCP))
128 PL_check[type] = *old_ck_p;
131 LT_CHECK_MUTEX_UNLOCK;
134 /* --- Helpers ------------------------------------------------------------- */
136 /* ... Thread-safe hints ................................................... */
138 #if LT_WORKAROUND_REQUIRE_PROPAGATION
145 #define LT_HINT_STRUCT 1
147 #define LT_HINT_CODE(H) ((H)->code)
149 #define LT_HINT_FREE(H) { \
150 lt_hint_t *h = (H); \
151 SvREFCNT_dec(h->code); \
152 PerlMemShared_free(h); \
155 #else /* LT_WORKAROUND_REQUIRE_PROPAGATION */
157 typedef SV lt_hint_t;
159 #define LT_HINT_STRUCT 0
161 #define LT_HINT_CODE(H) (H)
163 #define LT_HINT_FREE(H) SvREFCNT_dec(H);
165 #endif /* !LT_WORKAROUND_REQUIRE_PROPAGATION */
169 #define PTABLE_NAME ptable_hints
170 #define PTABLE_VAL_FREE(V) LT_HINT_FREE(V)
179 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
180 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
182 #endif /* LT_THREADSAFE */
184 /* ... "Seen" pointer table ................................................ */
186 #define PTABLE_NAME ptable_seen
187 #define PTABLE_VAL_FREE(V) NOOP
191 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
192 #define ptable_seen_store(T, K, V) ptable_seen_store(aPTBLMS_ (T), (K), (V))
193 #define ptable_seen_clear(T) ptable_seen_clear(aPTBLMS_ (T))
194 #define ptable_seen_free(T) ptable_seen_free(aPTBLMS_ (T))
196 /* ... Global data ......................................................... */
198 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
202 ptable *tbl; /* It really is a ptable_hints */
205 ptable *seen; /* It really is a ptable_seen */
211 /* ... Cloning global data ................................................. */
217 #if LT_HAS_PERL(5, 13, 2)
218 CLONE_PARAMS *params;
222 } lt_ptable_clone_ud;
224 #if LT_HAS_PERL(5, 13, 2)
225 # define lt_ptable_clone_ud_init(U, T, O) \
227 (U).params = Perl_clone_params_new((O), aTHX)
228 # define lt_ptable_clone_ud_deinit(U) Perl_clone_params_del((U).params)
229 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), (U)->params))
231 # define lt_ptable_clone_ud_init(U, T, O) \
233 (U).params.stashes = newAV(); \
234 (U).params.flags = 0; \
235 (U).params.proto_perl = (O)
236 # define lt_ptable_clone_ud_deinit(U) SvREFCNT_dec((U).params.stashes)
237 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), &((U)->params)))
240 STATIC void lt_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
241 lt_ptable_clone_ud *ud = ud_;
242 lt_hint_t *h1 = ent->val;
247 h2 = PerlMemShared_malloc(sizeof *h2);
248 h2->code = lt_dup_inc(h1->code, ud);
249 #if LT_WORKAROUND_REQUIRE_PROPAGATION
250 h2->require_tag = PTR2IV(lt_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
253 #else /* LT_HINT_STRUCT */
255 h2 = lt_dup_inc(h1, ud);
257 #endif /* !LT_HINT_STRUCT */
259 ptable_hints_store(ud->tbl, ent->key, h2);
264 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
267 ptable_hints_free(MY_CXT.tbl);
268 ptable_seen_free(MY_CXT.seen);
271 #endif /* LT_THREADSAFE */
273 /* ... Hint tags ........................................................... */
275 #if LT_WORKAROUND_REQUIRE_PROPAGATION
277 STATIC IV lt_require_tag(pTHX) {
278 #define lt_require_tag() lt_require_tag(aTHX)
279 const CV *cv, *outside;
284 /* If for some reason the pragma is operational at run-time, try to discover
285 * the current cv in use. */
288 for (si = PL_curstackinfo; si; si = si->si_prev) {
291 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
292 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
294 switch (CxTYPE(cx)) {
297 /* The propagation workaround is only needed up to 5.10.0 and at that
298 * time format and sub contexts were still identical. And even later the
299 * cv members offsets should have been kept the same. */
301 goto get_enclosing_cv;
303 cv = cx->blk_eval.cv;
304 goto get_enclosing_cv;
315 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
321 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
323 STATIC SV *lt_tag(pTHX_ SV *value) {
324 #define lt_tag(V) lt_tag(aTHX_ (V))
330 if (SvTYPE(value) >= SVt_PVCV) {
332 SvREFCNT_inc_simple_void_NN(code);
337 h = PerlMemShared_malloc(sizeof *h);
339 # if LT_WORKAROUND_REQUIRE_PROPAGATION
340 h->require_tag = lt_require_tag();
341 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
342 #else /* LT_HINT_STRUCT */
344 #endif /* !LT_HINT_STRUCT */
349 /* We only need for the key to be an unique tag for looking up the value later
350 * Allocated memory provides convenient unique identifiers, so that's why we
351 * use the hint as the key itself. */
352 ptable_hints_store(MY_CXT.tbl, h, h);
354 #endif /* LT_THREADSAFE */
356 return newSViv(PTR2IV(h));
359 STATIC SV *lt_detag(pTHX_ const SV *hint) {
360 #define lt_detag(H) lt_detag(aTHX_ (H))
366 if (!(hint && SvIOK(hint)))
369 h = INT2PTR(lt_hint_t *, SvIVX(hint));
371 h = ptable_fetch(MY_CXT.tbl, h);
372 #endif /* LT_THREADSAFE */
373 #if LT_WORKAROUND_REQUIRE_PROPAGATION
374 if (lt_require_tag() != h->require_tag)
376 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
378 return LT_HINT_CODE(h);
381 STATIC U32 lt_hash = 0;
383 STATIC SV *lt_hint(pTHX) {
384 #define lt_hint() lt_hint(aTHX)
386 #ifdef cop_hints_fetch_pvn
387 hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__, lt_hash,0);
388 #elif LT_HAS_PERL(5, 9, 5)
389 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
391 __PACKAGE__, __PACKAGE_LEN__,
395 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
400 return lt_detag(hint);
403 /* ... op => info map ...................................................... */
405 #define PTABLE_NAME ptable_map
406 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
410 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
411 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
412 #define ptable_map_delete(T, K) ptable_map_delete(aPTBLMS_ (T), (K))
416 STATIC perl_mutex lt_op_map_mutex;
418 #define LT_LOCK(M) MUTEX_LOCK(M)
419 #define LT_UNLOCK(M) MUTEX_UNLOCK(M)
421 #else /* USE_ITHREADS */
426 #endif /* !USE_ITHREADS */
428 STATIC ptable *lt_op_padxv_map = NULL;
433 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
435 #else /* MULTIPLICITY */
439 #endif /* !MULTIPLICITY */
442 STATIC void lt_op_padxv_info_call(pTHX_ const lt_op_padxv_info *oi, SV *sv) {
443 #define lt_op_padxv_info_call(O, S) lt_op_padxv_info_call(aTHX_ (O), (S))
444 SV *orig_pkg, *type_pkg, *type_meth;
453 STRLEN op_len = oi->orig_pkg_len, tp_len = oi->type_pkg_len;
455 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
456 SvREADONLY_on(orig_pkg);
458 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
459 SvREADONLY_on(type_pkg);
461 type_meth = sv_2mortal(newSVpvn(buf, oi->type_meth_len));
462 SvREADONLY_on(type_meth);
464 #else /* MULTIPLICITY */
465 orig_pkg = oi->orig_pkg;
466 type_pkg = oi->type_pkg;
467 type_meth = oi->type_meth;
468 #endif /* !MULTIPLICITY */
477 items = call_sv(type_meth, G_ARRAY | G_METHOD);
487 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
497 STATIC void lt_padxv_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp)(pTHX)) {
498 #define lt_padxv_map_store(O, OP, TP, TM, PP) lt_padxv_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
499 lt_op_padxv_info *oi;
501 LT_LOCK(<_op_map_mutex);
503 if (!(oi = ptable_fetch(lt_op_padxv_map, o))) {
504 oi = PerlMemShared_malloc(sizeof *oi);
505 ptable_map_store(lt_op_padxv_map, o, oi);
509 #else /* MULTIPLICITY */
511 SvREFCNT_dec(oi->orig_pkg);
512 SvREFCNT_dec(oi->type_pkg);
513 SvREFCNT_dec(oi->type_meth);
514 #endif /* !MULTIPLICITY */
519 STRLEN op_len = SvCUR(orig_pkg);
520 STRLEN tp_len = SvCUR(type_pkg);
521 STRLEN tm_len = SvCUR(type_meth);
522 STRLEN new_buf_size = op_len + tp_len + tm_len;
524 if (new_buf_size > oi->buf_size) {
525 PerlMemShared_free(oi->buf);
526 oi->buf = PerlMemShared_malloc(new_buf_size);
527 oi->buf_size = new_buf_size;
530 Copy(SvPVX(orig_pkg), buf, op_len, char);
532 Copy(SvPVX(type_pkg), buf, tp_len, char);
534 Copy(SvPVX(type_meth), buf, tm_len, char);
535 oi->orig_pkg_len = op_len;
536 oi->type_pkg_len = tp_len;
537 oi->type_meth_len = tm_len;
538 SvREFCNT_dec(orig_pkg);
539 SvREFCNT_dec(type_pkg);
540 SvREFCNT_dec(type_meth);
542 #else /* MULTIPLICITY */
543 oi->orig_pkg = orig_pkg;
544 oi->type_pkg = type_pkg;
545 oi->type_meth = type_meth;
546 #endif /* !MULTIPLICITY */
550 LT_UNLOCK(<_op_map_mutex);
553 STATIC const lt_op_padxv_info *lt_padxv_map_fetch(const OP *o, lt_op_padxv_info *oi) {
554 const lt_op_padxv_info *val;
556 LT_LOCK(<_op_map_mutex);
558 val = ptable_fetch(lt_op_padxv_map, o);
564 LT_UNLOCK(<_op_map_mutex);
569 STATIC void lt_map_delete(pTHX_ const OP *o) {
570 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
571 LT_LOCK(<_op_map_mutex);
573 ptable_map_delete(lt_op_padxv_map, o);
575 LT_UNLOCK(<_op_map_mutex);
578 /* --- Hooks --------------------------------------------------------------- */
580 /* ... Our pp_padsv ........................................................ */
582 STATIC OP *lt_pp_padsv(pTHX) {
585 if (lt_padxv_map_fetch(PL_op, &oi)) {
587 lt_op_padxv_info_call(&oi, TARG);
588 return oi.old_pp(aTHX);
591 return PL_op->op_ppaddr(aTHX);
594 /* ... Our ck_pad{any,sv} .................................................. */
596 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
597 * function, but are instead manually mutated from a padany. So we store
598 * the op entry in the op map in the padany check function, and we set their
599 * op_ppaddr member in our peephole optimizer replacement below. */
601 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
603 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
607 o = lt_old_ck_padany(aTHX_ o);
609 stash = PL_in_my_stash;
610 if (stash && (code = lt_hint())) {
612 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
613 SV *orig_meth = MY_CXT.default_meth;
615 SV *type_meth = NULL;
620 SvREADONLY_on(orig_pkg);
631 items = call_sv(code, G_ARRAY);
635 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
637 SvREFCNT_dec(orig_pkg);
646 type_meth = newSVsv(rsv);
647 SvREADONLY_on(type_meth);
652 type_pkg = newSVsv(rsv);
653 SvREADONLY_on(type_pkg);
663 SvREFCNT_inc_simple_void_NN(orig_pkg);
667 type_meth = orig_meth;
668 SvREFCNT_inc_simple_void_NN(orig_meth);
671 lt_padxv_map_store(o, orig_pkg, type_pkg, type_meth, o->op_ppaddr);
680 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
682 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
685 return lt_old_ck_padsv(aTHX_ o);
688 /* ... Our peephole optimizer .............................................. */
690 STATIC peep_t lt_old_peep = 0; /* This is actually the rpeep past 5.13.5 */
692 STATIC void lt_peep_rec(pTHX_ OP *o, ptable *seen) {
693 #define lt_peep_rec(O) lt_peep_rec(aTHX_ (O), seen)
694 for (; o; o = o->op_next) {
695 if (ptable_fetch(seen, o))
697 ptable_seen_store(seen, o, o);
699 switch (o->op_type) {
701 if (o->op_ppaddr != lt_pp_padsv && o->op_private & OPpLVAL_INTRO) {
702 lt_op_padxv_info *oi;
703 LT_LOCK(<_op_map_mutex);
704 oi = ptable_fetch(lt_op_padxv_map, o);
706 oi->old_pp = o->op_ppaddr;
707 o->op_ppaddr = lt_pp_padsv;
709 LT_UNLOCK(<_op_map_mutex);
721 # if LT_HAS_PERL(5, 10, 0)
726 lt_peep_rec(cLOGOPo->op_other);
730 lt_peep_rec(cLOOPo->op_redoop);
731 lt_peep_rec(cLOOPo->op_nextop);
732 lt_peep_rec(cLOOPo->op_lastop);
734 # if LT_HAS_PERL(5, 9, 5)
736 lt_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
742 lt_peep_rec(cPMOPo->op_pmreplstart);
745 #endif /* !LT_HAS_RPEEP */
752 STATIC void lt_peep(pTHX_ OP *o) {
754 ptable *seen = MY_CXT.seen;
756 lt_old_peep(aTHX_ o);
758 ptable_seen_clear(seen);
760 ptable_seen_clear(seen);
763 /* --- Interpreter setup/teardown ------------------------------------------ */
766 STATIC U32 lt_initialized = 0;
768 STATIC void lt_teardown(pTHX_ void *root) {
780 ptable_hints_free(MY_CXT.tbl);
782 ptable_seen_free(MY_CXT.seen);
783 SvREFCNT_dec(MY_CXT.default_meth);
786 lt_ck_restore(OP_PADANY, <_old_ck_padany);
787 lt_ck_restore(OP_PADSV, <_old_ck_padsv);
790 PL_rpeepp = lt_old_peep;
792 PL_peepp = lt_old_peep;
799 STATIC void lt_setup(pTHX) {
800 #define lt_setup() lt_setup(aTHX)
807 MY_CXT.tbl = ptable_new();
810 MY_CXT.seen = ptable_new();
811 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
812 SvREADONLY_on(MY_CXT.default_meth);
815 lt_ck_replace(OP_PADANY, lt_ck_padany, <_old_ck_padany);
816 lt_ck_replace(OP_PADSV, lt_ck_padsv, <_old_ck_padsv);
819 lt_old_peep = PL_rpeepp;
822 lt_old_peep = PL_peepp;
827 call_atexit(lt_teardown, aTHX);
829 call_atexit(lt_teardown, NULL);
835 STATIC U32 lt_booted = 0;
837 /* --- XS ------------------------------------------------------------------ */
839 MODULE = Lexical::Types PACKAGE = Lexical::Types
848 lt_op_padxv_map = ptable_new();
850 MUTEX_INIT(<_op_map_mutex);
853 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
855 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
856 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
857 newCONSTSUB(stash, "LT_FORKSAFE", newSVuv(LT_FORKSAFE));
871 SV *cloned_default_meth;
875 lt_ptable_clone_ud ud;
879 lt_ptable_clone_ud_init(ud, t, MY_CXT.owner);
880 ptable_walk(MY_CXT.tbl, lt_ptable_clone, &ud);
881 cloned_default_meth = lt_dup_inc(MY_CXT.default_meth, &ud);
882 lt_ptable_clone_ud_deinit(ud);
891 MY_CXT.default_meth = cloned_default_meth;
893 reap(3, lt_thread_cleanup, NULL);
902 RETVAL = lt_tag(value);