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 HvNAME_get(H) HvNAME(H)
35 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
38 #ifndef SvREFCNT_inc_simple_NN
39 # define SvREFCNT_inc_simple_NN SvREFCNT_inc
42 /* ... Thread safety and multiplicity ...................................... */
44 #ifndef LT_MULTIPLICITY
45 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
46 # define LT_MULTIPLICITY 1
48 # define LT_MULTIPLICITY 0
51 #if LT_MULTIPLICITY && !defined(tTHX)
52 # define tTHX PerlInterpreter*
55 #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))
56 # define LT_THREADSAFE 1
58 # define MY_CXT_CLONE \
60 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
61 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
62 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
65 # define LT_THREADSAFE 0
67 # define dMY_CXT dNOOP
69 # define MY_CXT lt_globaldata
71 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
73 # define MY_CXT_INIT NOOP
75 # define MY_CXT_CLONE NOOP
86 /* --- Helpers ------------------------------------------------------------- */
88 /* ... Thread-safe hints ................................................... */
90 #if LT_WORKAROUND_REQUIRE_PROPAGATION
97 #define LT_HINT_STRUCT 1
99 #define LT_HINT_CODE(H) ((H)->code)
101 #define LT_HINT_FREE(H) { \
102 lt_hint_t *h = (H); \
103 SvREFCNT_dec(h->code); \
104 PerlMemShared_free(h); \
107 #else /* LT_WORKAROUND_REQUIRE_PROPAGATION */
109 typedef SV lt_hint_t;
111 #define LT_HINT_STRUCT 0
113 #define LT_HINT_CODE(H) (H)
115 #define LT_HINT_FREE(H) SvREFCNT_dec(H);
117 #endif /* !LT_WORKAROUND_REQUIRE_PROPAGATION */
121 #define PTABLE_NAME ptable_hints
122 #define PTABLE_VAL_FREE(V) LT_HINT_FREE(V)
131 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
132 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
134 #endif /* LT_THREADSAFE */
136 /* ... Global data ......................................................... */
138 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
142 ptable *tbl; /* It really is a ptable_hints */
146 OP * (*pp_padsv_saved)(pTHX);
151 /* ... Cloning global data ................................................. */
157 #if LT_HAS_PERL(5, 13, 2)
158 CLONE_PARAMS *params;
162 } lt_ptable_clone_ud;
164 #if LT_HAS_PERL(5, 13, 2)
165 # define lt_ptable_clone_ud_init(U, T, O) \
167 (U).params = Perl_clone_params_new((O), aTHX)
168 # define lt_ptable_clone_ud_deinit(U) Perl_clone_params_del((U).params)
169 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), (U)->params))
171 # define lt_ptable_clone_ud_init(U, T, O) \
173 (U).params.stashes = newAV(); \
174 (U).params.flags = 0; \
175 (U).params.proto_perl = (O)
176 # define lt_ptable_clone_ud_deinit(U) SvREFCNT_dec((U).params.stashes)
177 # define lt_dup_inc(S, U) SvREFCNT_inc(sv_dup((S), &((U)->params)))
180 STATIC void lt_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
181 lt_ptable_clone_ud *ud = ud_;
182 lt_hint_t *h1 = ent->val;
187 h2 = PerlMemShared_malloc(sizeof *h2);
188 h2->code = lt_dup_inc(h1->code, ud);
189 #if LT_WORKAROUND_REQUIRE_PROPAGATION
190 h2->require_tag = PTR2IV(lt_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
193 #else /* LT_HINT_STRUCT */
195 h2 = lt_dup_inc(h1, ud);
197 #endif /* !LT_HINT_STRUCT */
199 ptable_hints_store(ud->tbl, ent->key, h2);
204 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
207 ptable_hints_free(MY_CXT.tbl);
210 #endif /* LT_THREADSAFE */
212 /* ... Hint tags ........................................................... */
214 #if LT_WORKAROUND_REQUIRE_PROPAGATION
215 STATIC IV lt_require_tag(pTHX) {
216 #define lt_require_tag() lt_require_tag(aTHX)
217 const CV *cv, *outside;
222 /* If for some reason the pragma is operational at run-time, try to discover
223 * the current cv in use. */
226 for (si = PL_curstackinfo; si; si = si->si_prev) {
229 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
230 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
232 switch (CxTYPE(cx)) {
235 /* The propagation workaround is only needed up to 5.10.0 and at that
236 * time format and sub contexts were still identical. And even later the
237 * cv members offsets should have been kept the same. */
239 goto get_enclosing_cv;
241 cv = cx->blk_eval.cv;
242 goto get_enclosing_cv;
253 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
258 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
260 STATIC SV *lt_tag(pTHX_ SV *value) {
261 #define lt_tag(V) lt_tag(aTHX_ (V))
268 if (SvTYPE(value) >= SVt_PVCV) {
270 SvREFCNT_inc_simple_NN(code);
275 h = PerlMemShared_malloc(sizeof *h);
277 # if LT_WORKAROUND_REQUIRE_PROPAGATION
278 h->require_tag = lt_require_tag();
279 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
280 #else /* LT_HINT_STRUCT */
282 #endif /* !LT_HINT_STRUCT */
285 /* We only need for the key to be an unique tag for looking up the value later.
286 * Allocated memory provides convenient unique identifiers, so that's why we
287 * use the hint as the key itself. */
288 ptable_hints_store(MY_CXT.tbl, h, h);
289 #endif /* LT_THREADSAFE */
291 return newSViv(PTR2IV(h));
294 STATIC SV *lt_detag(pTHX_ const SV *hint) {
295 #define lt_detag(H) lt_detag(aTHX_ (H))
299 if (!(hint && SvIOK(hint)))
302 h = INT2PTR(lt_hint_t *, SvIVX(hint));
304 h = ptable_fetch(MY_CXT.tbl, h);
305 #endif /* LT_THREADSAFE */
306 #if LT_WORKAROUND_REQUIRE_PROPAGATION
307 if (lt_require_tag() != h->require_tag)
309 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
311 return LT_HINT_CODE(h);
314 STATIC U32 lt_hash = 0;
316 STATIC SV *lt_hint(pTHX) {
317 #define lt_hint() lt_hint(aTHX)
319 #ifdef cop_hints_fetch_pvn
320 hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__, lt_hash,0);
321 #elif LT_HAS_PERL(5, 9, 5)
322 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
324 __PACKAGE__, __PACKAGE_LEN__,
328 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
333 return lt_detag(hint);
336 /* ... op => info map ...................................................... */
338 #define PTABLE_NAME ptable_map
339 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
343 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
344 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
346 STATIC ptable *lt_op_map = NULL;
349 STATIC perl_mutex lt_op_map_mutex;
354 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
356 #else /* MULTIPLICITY */
360 #endif /* !MULTIPLICITY */
361 OP *(*old_pp_padsv)(pTHX);
364 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
365 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
369 MUTEX_LOCK(<_op_map_mutex);
372 if (!(oi = ptable_fetch(lt_op_map, o))) {
373 oi = PerlMemShared_malloc(sizeof *oi);
374 ptable_map_store(lt_op_map, o, oi);
378 #else /* MULTIPLICITY */
380 SvREFCNT_dec(oi->orig_pkg);
381 SvREFCNT_dec(oi->type_pkg);
382 SvREFCNT_dec(oi->type_meth);
383 #endif /* !MULTIPLICITY */
388 STRLEN op_len = SvCUR(orig_pkg);
389 STRLEN tp_len = SvCUR(type_pkg);
390 STRLEN tm_len = SvCUR(type_meth);
391 STRLEN new_buf_size = op_len + tp_len + tm_len;
393 if (new_buf_size > oi->buf_size) {
394 PerlMemShared_free(oi->buf);
395 oi->buf = PerlMemShared_malloc(new_buf_size);
396 oi->buf_size = new_buf_size;
399 Copy(SvPVX(orig_pkg), buf, op_len, char);
401 Copy(SvPVX(type_pkg), buf, tp_len, char);
403 Copy(SvPVX(type_meth), buf, tm_len, char);
404 oi->orig_pkg_len = op_len;
405 oi->type_pkg_len = tp_len;
406 oi->type_meth_len = tm_len;
407 SvREFCNT_dec(orig_pkg);
408 SvREFCNT_dec(type_pkg);
409 SvREFCNT_dec(type_meth);
411 #else /* MULTIPLICITY */
412 oi->orig_pkg = orig_pkg;
413 oi->type_pkg = type_pkg;
414 oi->type_meth = type_meth;
415 #endif /* !MULTIPLICITY */
417 oi->old_pp_padsv = old_pp_padsv;
420 MUTEX_UNLOCK(<_op_map_mutex);
424 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
425 const lt_op_info *val;
428 MUTEX_LOCK(<_op_map_mutex);
431 val = ptable_fetch(lt_op_map, o);
438 MUTEX_UNLOCK(<_op_map_mutex);
444 STATIC void lt_map_delete(pTHX_ const OP *o) {
445 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
447 MUTEX_LOCK(<_op_map_mutex);
450 ptable_map_delete(lt_op_map, o);
453 MUTEX_UNLOCK(<_op_map_mutex);
457 /* --- Hooks --------------------------------------------------------------- */
459 /* ... Our pp_padsv ........................................................ */
461 STATIC OP *lt_pp_padsv(pTHX) {
464 if ((PL_op->op_private & OPpLVAL_INTRO) && lt_map_fetch(PL_op, &oi)) {
465 PADOFFSET targ = PL_op->op_targ;
466 SV *sv = PAD_SVl(targ);
469 SV *orig_pkg, *type_pkg, *type_meth;
478 STRLEN op_len = oi.orig_pkg_len, tp_len = oi.type_pkg_len;
480 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
481 SvREADONLY_on(orig_pkg);
483 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
484 SvREADONLY_on(type_pkg);
486 type_meth = sv_2mortal(newSVpvn(buf, oi.type_meth_len));
487 SvREADONLY_on(type_meth);
489 #else /* MULTIPLICITY */
490 orig_pkg = oi.orig_pkg;
491 type_pkg = oi.type_pkg;
492 type_meth = oi.type_meth;
493 #endif /* !MULTIPLICITY */
502 items = call_sv(type_meth, G_ARRAY | G_METHOD);
512 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
520 return CALL_FPTR(oi.old_pp_padsv)(aTHX);
523 return CALL_FPTR(PL_ppaddr[OP_PADSV])(aTHX);
526 STATIC void lt_pp_padsv_save(pMY_CXT) {
527 #define lt_pp_padsv_save() lt_pp_padsv_save(aMY_CXT)
528 if (MY_CXT.pp_padsv_saved)
531 MY_CXT.pp_padsv_saved = PL_ppaddr[OP_PADSV];
532 PL_ppaddr[OP_PADSV] = lt_pp_padsv;
535 STATIC void lt_pp_padsv_restore(pMY_CXT_ OP *o) {
536 #define lt_pp_padsv_restore(O) lt_pp_padsv_restore(aMY_CXT_ (O))
537 OP *(*saved)(pTHX) = MY_CXT.pp_padsv_saved;
542 if (o->op_ppaddr == lt_pp_padsv)
543 o->op_ppaddr = saved;
545 PL_ppaddr[OP_PADSV] = saved;
546 MY_CXT.pp_padsv_saved = 0;
549 /* ... Our ck_pad{any,sv} .................................................. */
551 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
552 * function, but are instead manually mutated from a PADANY. This is why we set
553 * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
554 * their pp_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
555 * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
556 * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
559 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
561 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
566 lt_pp_padsv_restore(o);
568 o = CALL_FPTR(lt_old_ck_padany)(aTHX_ o);
570 stash = PL_in_my_stash;
571 if (stash && (code = lt_hint())) {
572 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
573 SV *orig_meth = MY_CXT.default_meth;
575 SV *type_meth = NULL;
580 SvREADONLY_on(orig_pkg);
591 items = call_sv(code, G_ARRAY);
595 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
597 SvREFCNT_dec(orig_pkg);
606 type_meth = newSVsv(rsv);
607 SvREADONLY_on(type_meth);
612 type_pkg = newSVsv(rsv);
613 SvREADONLY_on(type_pkg);
623 SvREFCNT_inc(orig_pkg);
627 type_meth = orig_meth;
628 SvREFCNT_inc(orig_meth);
633 lt_map_store(o, orig_pkg, type_pkg, type_meth, MY_CXT.pp_padsv_saved);
642 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
644 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
647 lt_pp_padsv_restore(o);
651 return CALL_FPTR(lt_old_ck_padsv)(aTHX_ o);
654 STATIC U32 lt_initialized = 0;
656 STATIC void lt_teardown(pTHX_ void *root) {
668 ptable_hints_free(MY_CXT.tbl);
670 SvREFCNT_dec(MY_CXT.default_meth);
672 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_old_ck_padany);
673 lt_old_ck_padany = 0;
674 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_old_ck_padsv);
680 STATIC void lt_setup(pTHX) {
681 #define lt_setup() lt_setup(aTHX)
688 MY_CXT.tbl = ptable_new();
691 MY_CXT.pp_padsv_saved = 0;
692 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
693 SvREADONLY_on(MY_CXT.default_meth);
696 lt_old_ck_padany = PL_check[OP_PADANY];
697 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
698 lt_old_ck_padsv = PL_check[OP_PADSV];
699 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_ck_padsv);
702 call_atexit(lt_teardown, aTHX);
704 call_atexit(lt_teardown, NULL);
710 STATIC U32 lt_booted = 0;
712 /* --- XS ------------------------------------------------------------------ */
714 MODULE = Lexical::Types PACKAGE = Lexical::Types
723 lt_op_map = ptable_new();
725 MUTEX_INIT(<_op_map_mutex);
728 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
730 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
731 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
744 SV *cloned_default_meth;
747 lt_ptable_clone_ud ud;
751 lt_ptable_clone_ud_init(ud, t, MY_CXT.owner);
752 ptable_walk(MY_CXT.tbl, lt_ptable_clone, &ud);
753 cloned_default_meth = lt_dup_inc(MY_CXT.default_meth, &ud);
754 lt_ptable_clone_ud_deinit(ud);
760 MY_CXT.pp_padsv_saved = 0;
761 MY_CXT.default_meth = cloned_default_meth;
763 reap(3, lt_thread_cleanup, NULL);
772 RETVAL = lt_tag(value);