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))
414 STATIC ptable *lt_op_map = NULL;
418 STATIC perl_mutex lt_op_map_mutex;
420 #define LT_LOCK(M) MUTEX_LOCK(M)
421 #define LT_UNLOCK(M) MUTEX_UNLOCK(M)
423 #else /* USE_ITHREADS */
428 #endif /* !USE_ITHREADS */
432 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
434 #else /* MULTIPLICITY */
438 #endif /* !MULTIPLICITY */
439 OP *(*old_pp_padsv)(pTHX);
442 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
443 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
446 LT_LOCK(<_op_map_mutex);
448 if (!(oi = ptable_fetch(lt_op_map, o))) {
449 oi = PerlMemShared_malloc(sizeof *oi);
450 ptable_map_store(lt_op_map, o, oi);
454 #else /* MULTIPLICITY */
456 SvREFCNT_dec(oi->orig_pkg);
457 SvREFCNT_dec(oi->type_pkg);
458 SvREFCNT_dec(oi->type_meth);
459 #endif /* !MULTIPLICITY */
464 STRLEN op_len = SvCUR(orig_pkg);
465 STRLEN tp_len = SvCUR(type_pkg);
466 STRLEN tm_len = SvCUR(type_meth);
467 STRLEN new_buf_size = op_len + tp_len + tm_len;
469 if (new_buf_size > oi->buf_size) {
470 PerlMemShared_free(oi->buf);
471 oi->buf = PerlMemShared_malloc(new_buf_size);
472 oi->buf_size = new_buf_size;
475 Copy(SvPVX(orig_pkg), buf, op_len, char);
477 Copy(SvPVX(type_pkg), buf, tp_len, char);
479 Copy(SvPVX(type_meth), buf, tm_len, char);
480 oi->orig_pkg_len = op_len;
481 oi->type_pkg_len = tp_len;
482 oi->type_meth_len = tm_len;
483 SvREFCNT_dec(orig_pkg);
484 SvREFCNT_dec(type_pkg);
485 SvREFCNT_dec(type_meth);
487 #else /* MULTIPLICITY */
488 oi->orig_pkg = orig_pkg;
489 oi->type_pkg = type_pkg;
490 oi->type_meth = type_meth;
491 #endif /* !MULTIPLICITY */
493 oi->old_pp_padsv = old_pp_padsv;
495 LT_UNLOCK(<_op_map_mutex);
498 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
499 const lt_op_info *val;
501 LT_LOCK(<_op_map_mutex);
503 val = ptable_fetch(lt_op_map, o);
509 LT_UNLOCK(<_op_map_mutex);
514 STATIC void lt_map_delete(pTHX_ const OP *o) {
515 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
516 LT_LOCK(<_op_map_mutex);
518 ptable_map_delete(lt_op_map, o);
520 LT_UNLOCK(<_op_map_mutex);
523 /* --- Hooks --------------------------------------------------------------- */
525 /* ... Our pp_padsv ........................................................ */
527 STATIC OP *lt_pp_padsv(pTHX) {
530 if (lt_map_fetch(PL_op, &oi)) {
531 SV *orig_pkg, *type_pkg, *type_meth;
541 STRLEN op_len = oi.orig_pkg_len, tp_len = oi.type_pkg_len;
543 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
544 SvREADONLY_on(orig_pkg);
546 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
547 SvREADONLY_on(type_pkg);
549 type_meth = sv_2mortal(newSVpvn(buf, oi.type_meth_len));
550 SvREADONLY_on(type_meth);
552 #else /* MULTIPLICITY */
553 orig_pkg = oi.orig_pkg;
554 type_pkg = oi.type_pkg;
555 type_meth = oi.type_meth;
556 #endif /* !MULTIPLICITY */
565 items = call_sv(type_meth, G_ARRAY | G_METHOD);
572 sv_setsv(TARG, POPs);
575 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
582 return oi.old_pp_padsv(aTHX);
585 return PL_op->op_ppaddr(aTHX);
588 /* ... Our ck_pad{any,sv} .................................................. */
590 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
591 * function, but are instead manually mutated from a padany. So we store
592 * the op entry in the op map in the padany check function, and we set their
593 * op_ppaddr member in our peephole optimizer replacement below. */
595 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
597 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
601 o = lt_old_ck_padany(aTHX_ o);
603 stash = PL_in_my_stash;
604 if (stash && (code = lt_hint())) {
606 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
607 SV *orig_meth = MY_CXT.default_meth;
609 SV *type_meth = NULL;
614 SvREADONLY_on(orig_pkg);
625 items = call_sv(code, G_ARRAY);
629 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
631 SvREFCNT_dec(orig_pkg);
640 type_meth = newSVsv(rsv);
641 SvREADONLY_on(type_meth);
646 type_pkg = newSVsv(rsv);
647 SvREADONLY_on(type_pkg);
657 SvREFCNT_inc_simple_void_NN(orig_pkg);
661 type_meth = orig_meth;
662 SvREFCNT_inc_simple_void_NN(orig_meth);
665 lt_map_store(o, orig_pkg, type_pkg, type_meth, o->op_ppaddr);
674 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
676 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
679 return lt_old_ck_padsv(aTHX_ o);
682 /* ... Our peephole optimizer .............................................. */
684 STATIC peep_t lt_old_peep = 0; /* This is actually the rpeep past 5.13.5 */
686 STATIC void lt_peep_rec(pTHX_ OP *o, ptable *seen) {
687 #define lt_peep_rec(O) lt_peep_rec(aTHX_ (O), seen)
688 for (; o; o = o->op_next) {
689 lt_op_info *oi = NULL;
691 if (ptable_fetch(seen, o))
693 ptable_seen_store(seen, o, o);
695 switch (o->op_type) {
697 if (o->op_ppaddr != lt_pp_padsv && o->op_private & OPpLVAL_INTRO) {
698 LT_LOCK(<_op_map_mutex);
699 oi = ptable_fetch(lt_op_map, o);
701 oi->old_pp_padsv = o->op_ppaddr;
702 o->op_ppaddr = lt_pp_padsv;
704 LT_UNLOCK(<_op_map_mutex);
716 # if LT_HAS_PERL(5, 10, 0)
721 lt_peep_rec(cLOGOPo->op_other);
725 lt_peep_rec(cLOOPo->op_redoop);
726 lt_peep_rec(cLOOPo->op_nextop);
727 lt_peep_rec(cLOOPo->op_lastop);
729 # if LT_HAS_PERL(5, 9, 5)
731 lt_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
737 lt_peep_rec(cPMOPo->op_pmreplstart);
740 #endif /* !LT_HAS_RPEEP */
747 STATIC void lt_peep(pTHX_ OP *o) {
749 ptable *seen = MY_CXT.seen;
751 lt_old_peep(aTHX_ o);
753 ptable_seen_clear(seen);
755 ptable_seen_clear(seen);
758 /* --- Interpreter setup/teardown ------------------------------------------ */
761 STATIC U32 lt_initialized = 0;
763 STATIC void lt_teardown(pTHX_ void *root) {
775 ptable_hints_free(MY_CXT.tbl);
777 ptable_seen_free(MY_CXT.seen);
778 SvREFCNT_dec(MY_CXT.default_meth);
781 lt_ck_restore(OP_PADANY, <_old_ck_padany);
782 lt_ck_restore(OP_PADSV, <_old_ck_padsv);
785 PL_rpeepp = lt_old_peep;
787 PL_peepp = lt_old_peep;
794 STATIC void lt_setup(pTHX) {
795 #define lt_setup() lt_setup(aTHX)
802 MY_CXT.tbl = ptable_new();
805 MY_CXT.seen = ptable_new();
806 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
807 SvREADONLY_on(MY_CXT.default_meth);
810 lt_ck_replace(OP_PADANY, lt_ck_padany, <_old_ck_padany);
811 lt_ck_replace(OP_PADSV, lt_ck_padsv, <_old_ck_padsv);
814 lt_old_peep = PL_rpeepp;
817 lt_old_peep = PL_peepp;
822 call_atexit(lt_teardown, aTHX);
824 call_atexit(lt_teardown, NULL);
830 STATIC U32 lt_booted = 0;
832 /* --- XS ------------------------------------------------------------------ */
834 MODULE = Lexical::Types PACKAGE = Lexical::Types
843 lt_op_map = ptable_new();
845 MUTEX_INIT(<_op_map_mutex);
848 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
850 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
851 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
852 newCONSTSUB(stash, "LT_FORKSAFE", newSVuv(LT_FORKSAFE));
866 SV *cloned_default_meth;
870 lt_ptable_clone_ud ud;
874 lt_ptable_clone_ud_init(ud, t, MY_CXT.owner);
875 ptable_walk(MY_CXT.tbl, lt_ptable_clone, &ud);
876 cloned_default_meth = lt_dup_inc(MY_CXT.default_meth, &ud);
877 lt_ptable_clone_ud_deinit(ud);
886 MY_CXT.default_meth = cloned_default_meth;
888 reap(3, lt_thread_cleanup, NULL);
897 RETVAL = lt_tag(value);