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 ................................................ */
148 #define PTABLE_NAME ptable_seen
149 #define PTABLE_VAL_FREE(V) NOOP
153 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
154 #define ptable_seen_store(T, K, V) ptable_seen_store(aPTBLMS_ (T), (K), (V))
155 #define ptable_seen_clear(T) ptable_seen_clear(aPTBLMS_ (T))
156 #define ptable_seen_free(T) ptable_seen_free(aPTBLMS_ (T))
158 /* ... Global data ......................................................... */
160 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
164 ptable *tbl; /* It really is a ptable_hints */
167 ptable *seen; /* It really is a ptable_seen */
173 /* ... Cloning global data ................................................. */
179 #if LT_HAS_PERL(5, 13, 2)
180 CLONE_PARAMS *params;
184 } lt_ptable_clone_ud;
186 #if LT_HAS_PERL(5, 13, 2)
187 # define lt_ptable_clone_ud_init(U, T, O) \
189 (U).params = Perl_clone_params_new((O), aTHX)
190 # define lt_ptable_clone_ud_deinit(U) Perl_clone_params_del((U).params)
191 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), (U)->params))
193 # define lt_ptable_clone_ud_init(U, T, O) \
195 (U).params.stashes = newAV(); \
196 (U).params.flags = 0; \
197 (U).params.proto_perl = (O)
198 # define lt_ptable_clone_ud_deinit(U) SvREFCNT_dec((U).params.stashes)
199 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), &((U)->params)))
202 STATIC void lt_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
203 lt_ptable_clone_ud *ud = ud_;
204 lt_hint_t *h1 = ent->val;
209 h2 = PerlMemShared_malloc(sizeof *h2);
210 h2->code = lt_dup_inc(h1->code, ud);
211 #if LT_WORKAROUND_REQUIRE_PROPAGATION
212 h2->require_tag = PTR2IV(lt_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
215 #else /* LT_HINT_STRUCT */
217 h2 = lt_dup_inc(h1, ud);
219 #endif /* !LT_HINT_STRUCT */
221 ptable_hints_store(ud->tbl, ent->key, h2);
226 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
229 ptable_hints_free(MY_CXT.tbl);
230 ptable_seen_free(MY_CXT.seen);
233 #endif /* LT_THREADSAFE */
235 /* ... Hint tags ........................................................... */
237 #if LT_WORKAROUND_REQUIRE_PROPAGATION
239 STATIC IV lt_require_tag(pTHX) {
240 #define lt_require_tag() lt_require_tag(aTHX)
241 const CV *cv, *outside;
246 /* If for some reason the pragma is operational at run-time, try to discover
247 * the current cv in use. */
250 for (si = PL_curstackinfo; si; si = si->si_prev) {
253 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
254 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
256 switch (CxTYPE(cx)) {
259 /* The propagation workaround is only needed up to 5.10.0 and at that
260 * time format and sub contexts were still identical. And even later the
261 * cv members offsets should have been kept the same. */
263 goto get_enclosing_cv;
265 cv = cx->blk_eval.cv;
266 goto get_enclosing_cv;
277 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
283 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
285 STATIC SV *lt_tag(pTHX_ SV *value) {
286 #define lt_tag(V) lt_tag(aTHX_ (V))
292 if (SvTYPE(value) >= SVt_PVCV) {
294 SvREFCNT_inc_simple_NN(code);
299 h = PerlMemShared_malloc(sizeof *h);
301 # if LT_WORKAROUND_REQUIRE_PROPAGATION
302 h->require_tag = lt_require_tag();
303 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
304 #else /* LT_HINT_STRUCT */
306 #endif /* !LT_HINT_STRUCT */
311 /* We only need for the key to be an unique tag for looking up the value later
312 * Allocated memory provides convenient unique identifiers, so that's why we
313 * use the hint as the key itself. */
314 ptable_hints_store(MY_CXT.tbl, h, h);
316 #endif /* LT_THREADSAFE */
318 return newSViv(PTR2IV(h));
321 STATIC SV *lt_detag(pTHX_ const SV *hint) {
322 #define lt_detag(H) lt_detag(aTHX_ (H))
328 if (!(hint && SvIOK(hint)))
331 h = INT2PTR(lt_hint_t *, SvIVX(hint));
333 h = ptable_fetch(MY_CXT.tbl, h);
334 #endif /* LT_THREADSAFE */
335 #if LT_WORKAROUND_REQUIRE_PROPAGATION
336 if (lt_require_tag() != h->require_tag)
338 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
340 return LT_HINT_CODE(h);
343 STATIC U32 lt_hash = 0;
345 STATIC SV *lt_hint(pTHX) {
346 #define lt_hint() lt_hint(aTHX)
348 #ifdef cop_hints_fetch_pvn
349 hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__, lt_hash,0);
350 #elif LT_HAS_PERL(5, 9, 5)
351 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
353 __PACKAGE__, __PACKAGE_LEN__,
357 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
362 return lt_detag(hint);
365 /* ... op => info map ...................................................... */
367 #define PTABLE_NAME ptable_map
368 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
372 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
373 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
374 #define ptable_map_delete(T, K) ptable_map_delete(aPTBLMS_ (T), (K))
376 STATIC ptable *lt_op_map = NULL;
380 STATIC perl_mutex lt_op_map_mutex;
382 #define LT_LOCK(M) MUTEX_LOCK(M)
383 #define LT_UNLOCK(M) MUTEX_UNLOCK(M)
385 #else /* USE_ITHREADS */
390 #endif /* !USE_ITHREADS */
394 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
396 #else /* MULTIPLICITY */
400 #endif /* !MULTIPLICITY */
401 OP *(*old_pp_padsv)(pTHX);
404 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
405 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
408 LT_LOCK(<_op_map_mutex);
410 if (!(oi = ptable_fetch(lt_op_map, o))) {
411 oi = PerlMemShared_malloc(sizeof *oi);
412 ptable_map_store(lt_op_map, o, oi);
416 #else /* MULTIPLICITY */
418 SvREFCNT_dec(oi->orig_pkg);
419 SvREFCNT_dec(oi->type_pkg);
420 SvREFCNT_dec(oi->type_meth);
421 #endif /* !MULTIPLICITY */
426 STRLEN op_len = SvCUR(orig_pkg);
427 STRLEN tp_len = SvCUR(type_pkg);
428 STRLEN tm_len = SvCUR(type_meth);
429 STRLEN new_buf_size = op_len + tp_len + tm_len;
431 if (new_buf_size > oi->buf_size) {
432 PerlMemShared_free(oi->buf);
433 oi->buf = PerlMemShared_malloc(new_buf_size);
434 oi->buf_size = new_buf_size;
437 Copy(SvPVX(orig_pkg), buf, op_len, char);
439 Copy(SvPVX(type_pkg), buf, tp_len, char);
441 Copy(SvPVX(type_meth), buf, tm_len, char);
442 oi->orig_pkg_len = op_len;
443 oi->type_pkg_len = tp_len;
444 oi->type_meth_len = tm_len;
445 SvREFCNT_dec(orig_pkg);
446 SvREFCNT_dec(type_pkg);
447 SvREFCNT_dec(type_meth);
449 #else /* MULTIPLICITY */
450 oi->orig_pkg = orig_pkg;
451 oi->type_pkg = type_pkg;
452 oi->type_meth = type_meth;
453 #endif /* !MULTIPLICITY */
455 oi->old_pp_padsv = old_pp_padsv;
457 LT_UNLOCK(<_op_map_mutex);
460 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
461 const lt_op_info *val;
463 LT_LOCK(<_op_map_mutex);
465 val = ptable_fetch(lt_op_map, o);
471 LT_UNLOCK(<_op_map_mutex);
476 STATIC void lt_map_delete(pTHX_ const OP *o) {
477 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
478 LT_LOCK(<_op_map_mutex);
480 ptable_map_delete(lt_op_map, o);
482 LT_UNLOCK(<_op_map_mutex);
485 /* --- Hooks --------------------------------------------------------------- */
487 /* ... Our pp_padsv ........................................................ */
489 STATIC OP *lt_pp_padsv(pTHX) {
492 if (lt_map_fetch(PL_op, &oi)) {
493 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);
534 sv_setsv(TARG, POPs);
537 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
544 return oi.old_pp_padsv(aTHX);
547 return PL_op->op_ppaddr(aTHX);
550 /* ... Our ck_pad{any,sv} .................................................. */
552 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
553 * function, but are instead manually mutated from a padany. So we store
554 * the op entry in the op map in the padany check function, and we set their
555 * op_ppaddr member in our peephole optimizer replacement below. */
557 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
559 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
563 o = lt_old_ck_padany(aTHX_ o);
565 stash = PL_in_my_stash;
566 if (stash && (code = lt_hint())) {
568 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
569 SV *orig_meth = MY_CXT.default_meth;
571 SV *type_meth = NULL;
576 SvREADONLY_on(orig_pkg);
587 items = call_sv(code, G_ARRAY);
591 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
593 SvREFCNT_dec(orig_pkg);
602 type_meth = newSVsv(rsv);
603 SvREADONLY_on(type_meth);
608 type_pkg = newSVsv(rsv);
609 SvREADONLY_on(type_pkg);
619 SvREFCNT_inc(orig_pkg);
623 type_meth = orig_meth;
624 SvREFCNT_inc(orig_meth);
627 lt_map_store(o, orig_pkg, type_pkg, type_meth, o->op_ppaddr);
636 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
638 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
641 return lt_old_ck_padsv(aTHX_ o);
644 /* ... Our peephole optimizer .............................................. */
646 STATIC peep_t lt_old_peep = 0; /* This is actually the rpeep past 5.13.5 */
648 STATIC void lt_peep_rec(pTHX_ OP *o, ptable *seen) {
649 #define lt_peep_rec(O) lt_peep_rec(aTHX_ (O), seen)
650 for (; o; o = o->op_next) {
651 lt_op_info *oi = NULL;
653 if (ptable_fetch(seen, o))
655 ptable_seen_store(seen, o, o);
657 switch (o->op_type) {
659 if (o->op_ppaddr != lt_pp_padsv && o->op_private & OPpLVAL_INTRO) {
660 LT_LOCK(<_op_map_mutex);
661 oi = ptable_fetch(lt_op_map, o);
663 oi->old_pp_padsv = o->op_ppaddr;
664 o->op_ppaddr = lt_pp_padsv;
666 LT_UNLOCK(<_op_map_mutex);
678 # if LT_HAS_PERL(5, 10, 0)
683 lt_peep_rec(cLOGOPo->op_other);
687 lt_peep_rec(cLOOPo->op_redoop);
688 lt_peep_rec(cLOOPo->op_nextop);
689 lt_peep_rec(cLOOPo->op_lastop);
691 # if LT_HAS_PERL(5, 9, 5)
693 lt_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
699 lt_peep_rec(cPMOPo->op_pmreplstart);
702 #endif /* !LT_HAS_RPEEP */
709 STATIC void lt_peep(pTHX_ OP *o) {
711 ptable *seen = MY_CXT.seen;
713 lt_old_peep(aTHX_ o);
715 ptable_seen_clear(seen);
717 ptable_seen_clear(seen);
720 /* --- Interpreter setup/teardown ------------------------------------------ */
723 STATIC U32 lt_initialized = 0;
725 STATIC void lt_teardown(pTHX_ void *root) {
737 ptable_hints_free(MY_CXT.tbl);
739 ptable_seen_free(MY_CXT.seen);
740 SvREFCNT_dec(MY_CXT.default_meth);
743 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_old_ck_padany);
744 lt_old_ck_padany = 0;
745 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_old_ck_padsv);
749 PL_rpeepp = lt_old_peep;
751 PL_peepp = lt_old_peep;
758 STATIC void lt_setup(pTHX) {
759 #define lt_setup() lt_setup(aTHX)
766 MY_CXT.tbl = ptable_new();
769 MY_CXT.seen = ptable_new();
770 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
771 SvREADONLY_on(MY_CXT.default_meth);
774 lt_old_ck_padany = PL_check[OP_PADANY];
775 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
776 lt_old_ck_padsv = PL_check[OP_PADSV];
777 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_ck_padsv);
780 lt_old_peep = PL_rpeepp;
783 lt_old_peep = PL_peepp;
788 call_atexit(lt_teardown, aTHX);
790 call_atexit(lt_teardown, NULL);
796 STATIC U32 lt_booted = 0;
798 /* --- XS ------------------------------------------------------------------ */
800 MODULE = Lexical::Types PACKAGE = Lexical::Types
809 lt_op_map = ptable_new();
811 MUTEX_INIT(<_op_map_mutex);
814 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
816 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
817 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
818 newCONSTSUB(stash, "LT_FORKSAFE", newSVuv(LT_FORKSAFE));
832 SV *cloned_default_meth;
836 lt_ptable_clone_ud ud;
840 lt_ptable_clone_ud_init(ud, t, MY_CXT.owner);
841 ptable_walk(MY_CXT.tbl, lt_ptable_clone, &ud);
842 cloned_default_meth = lt_dup_inc(MY_CXT.default_meth, &ud);
843 lt_ptable_clone_ud_deinit(ud);
852 MY_CXT.default_meth = cloned_default_meth;
854 reap(3, lt_thread_cleanup, NULL);
863 RETVAL = lt_tag(value);