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 ................................................. */
155 STATIC SV *lt_clone(pTHX_ SV *sv, tTHX owner) {
156 #define lt_clone(S, O) lt_clone(aTHX_ (S), (O))
161 if (SvTYPE(sv) == SVt_PVHV && HvNAME_get(sv))
164 param.stashes = stashes;
166 param.proto_perl = owner;
168 dupsv = sv_dup(sv, ¶m);
172 SvREFCNT_dec(stashes);
175 return SvREFCNT_inc(dupsv);
178 STATIC void lt_ptable_hints_clone(pTHX_ ptable_ent *ent, void *ud_) {
180 lt_hint_t *h1 = ent->val;
183 if (ud->owner == aTHX)
188 h2 = PerlMemShared_malloc(sizeof *h2);
189 h2->code = lt_clone(h1->code, ud->owner);
190 SvREFCNT_inc(h2->code);
191 #if LT_WORKAROUND_REQUIRE_PROPAGATION
192 h2->require_tag = PTR2IV(lt_clone(INT2PTR(SV *, h1->require_tag), ud->owner));
195 #else /* LT_HINT_STRUCT */
197 h2 = lt_clone(h1, ud->owner);
200 #endif /* !LT_HINT_STRUCT */
202 ptable_hints_store(ud->tbl, ent->key, h2);
207 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
210 ptable_hints_free(MY_CXT.tbl);
213 #endif /* LT_THREADSAFE */
215 /* ... Hint tags ........................................................... */
217 #if LT_WORKAROUND_REQUIRE_PROPAGATION
218 STATIC IV lt_require_tag(pTHX) {
219 #define lt_require_tag() lt_require_tag(aTHX)
220 const CV *cv, *outside;
225 /* If for some reason the pragma is operational at run-time, try to discover
226 * the current cv in use. */
229 for (si = PL_curstackinfo; si; si = si->si_prev) {
232 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
233 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
235 switch (CxTYPE(cx)) {
238 /* The propagation workaround is only needed up to 5.10.0 and at that
239 * time format and sub contexts were still identical. And even later the
240 * cv members offsets should have been kept the same. */
242 goto get_enclosing_cv;
244 cv = cx->blk_eval.cv;
245 goto get_enclosing_cv;
256 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
261 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
263 STATIC SV *lt_tag(pTHX_ SV *value) {
264 #define lt_tag(V) lt_tag(aTHX_ (V))
271 if (SvTYPE(value) >= SVt_PVCV) {
273 SvREFCNT_inc_simple_NN(code);
278 h = PerlMemShared_malloc(sizeof *h);
280 # if LT_WORKAROUND_REQUIRE_PROPAGATION
281 h->require_tag = lt_require_tag();
282 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
283 #else /* LT_HINT_STRUCT */
285 #endif /* !LT_HINT_STRUCT */
288 /* We only need for the key to be an unique tag for looking up the value later.
289 * Allocated memory provides convenient unique identifiers, so that's why we
290 * use the hint as the key itself. */
291 ptable_hints_store(MY_CXT.tbl, h, h);
292 #endif /* LT_THREADSAFE */
294 return newSViv(PTR2IV(h));
297 STATIC SV *lt_detag(pTHX_ const SV *hint) {
298 #define lt_detag(H) lt_detag(aTHX_ (H))
302 if (!(hint && SvIOK(hint)))
305 h = INT2PTR(lt_hint_t *, SvIVX(hint));
307 h = ptable_fetch(MY_CXT.tbl, h);
308 #endif /* LT_THREADSAFE */
309 #if LT_WORKAROUND_REQUIRE_PROPAGATION
310 if (lt_require_tag() != h->require_tag)
312 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
314 return LT_HINT_CODE(h);
317 STATIC U32 lt_hash = 0;
319 STATIC SV *lt_hint(pTHX) {
320 #define lt_hint() lt_hint(aTHX)
322 #if LT_HAS_PERL(5, 9, 5)
323 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
325 __PACKAGE__, __PACKAGE_LEN__,
329 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
334 return lt_detag(hint);
337 /* ... op => info map ...................................................... */
339 #define PTABLE_NAME ptable_map
340 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
344 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
345 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
347 STATIC ptable *lt_op_map = NULL;
350 STATIC perl_mutex lt_op_map_mutex;
355 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
357 #else /* MULTIPLICITY */
361 #endif /* !MULTIPLICITY */
362 OP *(*old_pp_padsv)(pTHX);
365 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
366 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
370 MUTEX_LOCK(<_op_map_mutex);
373 if (!(oi = ptable_fetch(lt_op_map, o))) {
374 oi = PerlMemShared_malloc(sizeof *oi);
375 ptable_map_store(lt_op_map, o, oi);
379 #else /* MULTIPLICITY */
381 SvREFCNT_dec(oi->orig_pkg);
382 SvREFCNT_dec(oi->type_pkg);
383 SvREFCNT_dec(oi->type_meth);
384 #endif /* !MULTIPLICITY */
389 STRLEN op_len = SvCUR(orig_pkg);
390 STRLEN tp_len = SvCUR(type_pkg);
391 STRLEN tm_len = SvCUR(type_meth);
392 STRLEN new_buf_size = op_len + tp_len + tm_len;
394 if (new_buf_size > oi->buf_size) {
395 PerlMemShared_free(oi->buf);
396 oi->buf = PerlMemShared_malloc(new_buf_size);
397 oi->buf_size = new_buf_size;
400 Copy(SvPVX(orig_pkg), buf, op_len, char);
402 Copy(SvPVX(type_pkg), buf, tp_len, char);
404 Copy(SvPVX(type_meth), buf, tm_len, char);
405 oi->orig_pkg_len = op_len;
406 oi->type_pkg_len = tp_len;
407 oi->type_meth_len = tm_len;
408 SvREFCNT_dec(orig_pkg);
409 SvREFCNT_dec(type_pkg);
410 SvREFCNT_dec(type_meth);
412 #else /* MULTIPLICITY */
413 oi->orig_pkg = orig_pkg;
414 oi->type_pkg = type_pkg;
415 oi->type_meth = type_meth;
416 #endif /* !MULTIPLICITY */
418 oi->old_pp_padsv = old_pp_padsv;
421 MUTEX_UNLOCK(<_op_map_mutex);
425 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
426 const lt_op_info *val;
429 MUTEX_LOCK(<_op_map_mutex);
432 val = ptable_fetch(lt_op_map, o);
439 MUTEX_UNLOCK(<_op_map_mutex);
445 STATIC void lt_map_delete(pTHX_ const OP *o) {
446 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
448 MUTEX_LOCK(<_op_map_mutex);
451 ptable_map_store(lt_op_map, o, NULL);
454 MUTEX_UNLOCK(<_op_map_mutex);
458 /* --- Hooks --------------------------------------------------------------- */
460 /* ... Our pp_padsv ........................................................ */
462 STATIC OP *lt_pp_padsv(pTHX) {
465 if ((PL_op->op_private & OPpLVAL_INTRO) && lt_map_fetch(PL_op, &oi)) {
466 PADOFFSET targ = PL_op->op_targ;
467 SV *sv = PAD_SVl(targ);
470 SV *orig_pkg, *type_pkg, *type_meth;
479 STRLEN op_len = oi.orig_pkg_len, tp_len = oi.type_pkg_len;
481 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
482 SvREADONLY_on(orig_pkg);
484 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
485 SvREADONLY_on(type_pkg);
487 type_meth = sv_2mortal(newSVpvn(buf, oi.type_meth_len));
488 SvREADONLY_on(type_meth);
490 #else /* MULTIPLICITY */
491 orig_pkg = oi.orig_pkg;
492 type_pkg = oi.type_pkg;
493 type_meth = oi.type_meth;
494 #endif /* !MULTIPLICITY */
503 items = call_sv(type_meth, G_ARRAY | G_METHOD);
513 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
521 return CALL_FPTR(oi.old_pp_padsv)(aTHX);
524 return CALL_FPTR(PL_ppaddr[OP_PADSV])(aTHX);
527 STATIC void lt_pp_padsv_save(pMY_CXT) {
528 #define lt_pp_padsv_save() lt_pp_padsv_save(aMY_CXT)
529 if (MY_CXT.pp_padsv_saved)
532 MY_CXT.pp_padsv_saved = PL_ppaddr[OP_PADSV];
533 PL_ppaddr[OP_PADSV] = lt_pp_padsv;
536 STATIC void lt_pp_padsv_restore(pMY_CXT_ OP *o) {
537 #define lt_pp_padsv_restore(O) lt_pp_padsv_restore(aMY_CXT_ (O))
538 OP *(*saved)(pTHX) = MY_CXT.pp_padsv_saved;
543 if (o->op_ppaddr == lt_pp_padsv)
544 o->op_ppaddr = saved;
546 PL_ppaddr[OP_PADSV] = saved;
547 MY_CXT.pp_padsv_saved = 0;
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. This is why we set
554 * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
555 * their pp_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
556 * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
557 * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
560 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
562 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
567 lt_pp_padsv_restore(o);
569 o = CALL_FPTR(lt_old_ck_padany)(aTHX_ o);
571 stash = PL_in_my_stash;
572 if (stash && (code = lt_hint())) {
573 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
574 SV *orig_meth = MY_CXT.default_meth;
576 SV *type_meth = NULL;
581 SvREADONLY_on(orig_pkg);
592 items = call_sv(code, G_ARRAY);
596 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
598 SvREFCNT_dec(orig_pkg);
607 type_meth = newSVsv(rsv);
608 SvREADONLY_on(type_meth);
613 type_pkg = newSVsv(rsv);
614 SvREADONLY_on(type_pkg);
624 SvREFCNT_inc(orig_pkg);
628 type_meth = orig_meth;
629 SvREFCNT_inc(orig_meth);
634 lt_map_store(o, orig_pkg, type_pkg, type_meth, MY_CXT.pp_padsv_saved);
643 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
645 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
648 lt_pp_padsv_restore(o);
652 return CALL_FPTR(lt_old_ck_padsv)(aTHX_ o);
655 STATIC U32 lt_initialized = 0;
657 STATIC void lt_teardown(pTHX_ void *root) {
669 ptable_hints_free(MY_CXT.tbl);
671 SvREFCNT_dec(MY_CXT.default_meth);
673 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_old_ck_padany);
674 lt_old_ck_padany = 0;
675 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_old_ck_padsv);
681 STATIC void lt_setup(pTHX) {
682 #define lt_setup() lt_setup(aTHX)
689 MY_CXT.tbl = ptable_new();
692 MY_CXT.pp_padsv_saved = 0;
693 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
694 SvREADONLY_on(MY_CXT.default_meth);
697 lt_old_ck_padany = PL_check[OP_PADANY];
698 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
699 lt_old_ck_padsv = PL_check[OP_PADSV];
700 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_ck_padsv);
703 call_atexit(lt_teardown, aTHX);
705 call_atexit(lt_teardown, NULL);
711 STATIC U32 lt_booted = 0;
713 /* --- XS ------------------------------------------------------------------ */
715 MODULE = Lexical::Types PACKAGE = Lexical::Types
724 lt_op_map = ptable_new();
726 MUTEX_INIT(<_op_map_mutex);
729 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
731 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
732 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
745 SV *cloned_default_meth;
750 ud.tbl = t = ptable_new();
751 ud.owner = MY_CXT.owner;
752 ptable_walk(MY_CXT.tbl, lt_ptable_hints_clone, &ud);
753 cloned_default_meth = lt_clone(MY_CXT.default_meth, MY_CXT.owner);
759 MY_CXT.pp_padsv_saved = 0;
760 MY_CXT.default_meth = cloned_default_meth;
762 reap(3, lt_thread_cleanup, NULL);
771 RETVAL = lt_tag(value);