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
43 #if defined(ENTER_with_name) && !LT_HAS_PERL(5, 11, 4)
44 # define ENTERn(N) ENTER_with_name(N)
46 # define ENTERn(N) ENTER
50 #if defined(LEAVE_with_name) && !LT_HAS_PERL(5, 11, 4)
51 # define LEAVEn(N) LEAVE_with_name(N)
53 # define LEAVEn(N) LEAVE
56 /* ... Thread safety and multiplicity ...................................... */
58 #ifndef LT_MULTIPLICITY
59 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
60 # define LT_MULTIPLICITY 1
62 # define LT_MULTIPLICITY 0
65 #if LT_MULTIPLICITY && !defined(tTHX)
66 # define tTHX PerlInterpreter*
69 #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))
70 # define LT_THREADSAFE 1
72 # define MY_CXT_CLONE \
74 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
75 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
76 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
79 # define LT_THREADSAFE 0
81 # define dMY_CXT dNOOP
83 # define MY_CXT lt_globaldata
85 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
87 # define MY_CXT_INIT NOOP
89 # define MY_CXT_CLONE NOOP
100 /* --- Helpers ------------------------------------------------------------- */
102 /* ... Thread-safe hints ................................................... */
104 #if LT_WORKAROUND_REQUIRE_PROPAGATION
111 #define LT_HINT_STRUCT 1
113 #define LT_HINT_CODE(H) ((H)->code)
115 #define LT_HINT_FREE(H) { \
116 lt_hint_t *h = (H); \
117 SvREFCNT_dec(h->code); \
118 PerlMemShared_free(h); \
121 #else /* LT_WORKAROUND_REQUIRE_PROPAGATION */
123 typedef SV lt_hint_t;
125 #define LT_HINT_STRUCT 0
127 #define LT_HINT_CODE(H) (H)
129 #define LT_HINT_FREE(H) SvREFCNT_dec(H);
131 #endif /* !LT_WORKAROUND_REQUIRE_PROPAGATION */
135 #define PTABLE_NAME ptable_hints
136 #define PTABLE_VAL_FREE(V) LT_HINT_FREE(V)
145 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
146 #define ptable_hints_free(T) ptable_hints_free(aTHX_ (T))
148 #endif /* LT_THREADSAFE */
150 /* ... Global data ......................................................... */
152 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
156 ptable *tbl; /* It really is a ptable_hints */
160 OP * (*pp_padsv_saved)(pTHX);
165 /* ... Cloning global data ................................................. */
169 STATIC SV *lt_clone(pTHX_ SV *sv, tTHX owner) {
170 #define lt_clone(S, O) lt_clone(aTHX_ (S), (O))
175 if (SvTYPE(sv) == SVt_PVHV && HvNAME_get(sv))
178 param.stashes = stashes;
180 param.proto_perl = owner;
182 dupsv = sv_dup(sv, ¶m);
186 SvREFCNT_dec(stashes);
189 return SvREFCNT_inc(dupsv);
192 STATIC void lt_ptable_hints_clone(pTHX_ ptable_ent *ent, void *ud_) {
194 lt_hint_t *h1 = ent->val;
197 if (ud->owner == aTHX)
202 h2 = PerlMemShared_malloc(sizeof *h2);
203 h2->code = lt_clone(h1->code, ud->owner);
204 SvREFCNT_inc(h2->code);
205 #if LT_WORKAROUND_REQUIRE_PROPAGATION
206 h2->require_tag = PTR2IV(lt_clone(INT2PTR(SV *, h1->require_tag), ud->owner));
209 #else /* LT_HINT_STRUCT */
211 h2 = lt_clone(h1, ud->owner);
214 #endif /* !LT_HINT_STRUCT */
216 ptable_hints_store(ud->tbl, ent->key, h2);
221 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
224 ptable_hints_free(MY_CXT.tbl);
227 #endif /* LT_THREADSAFE */
229 /* ... Hint tags ........................................................... */
231 #if LT_WORKAROUND_REQUIRE_PROPAGATION
232 STATIC IV lt_require_tag(pTHX) {
233 #define lt_require_tag() lt_require_tag(aTHX)
234 const CV *cv, *outside;
239 /* If for some reason the pragma is operational at run-time, try to discover
240 * the current cv in use. */
243 for (si = PL_curstackinfo; si; si = si->si_prev) {
246 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
247 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
249 switch (CxTYPE(cx)) {
252 /* The propagation workaround is only needed up to 5.10.0 and at that
253 * time format and sub contexts were still identical. And even later the
254 * cv members offsets should have been kept the same. */
256 goto get_enclosing_cv;
258 cv = cx->blk_eval.cv;
259 goto get_enclosing_cv;
270 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
275 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
277 STATIC SV *lt_tag(pTHX_ SV *value) {
278 #define lt_tag(V) lt_tag(aTHX_ (V))
285 if (SvTYPE(value) >= SVt_PVCV) {
287 SvREFCNT_inc_simple_NN(code);
292 h = PerlMemShared_malloc(sizeof *h);
294 # if LT_WORKAROUND_REQUIRE_PROPAGATION
295 h->require_tag = lt_require_tag();
296 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
297 #else /* LT_HINT_STRUCT */
299 #endif /* !LT_HINT_STRUCT */
302 /* We only need for the key to be an unique tag for looking up the value later.
303 * Allocated memory provides convenient unique identifiers, so that's why we
304 * use the hint as the key itself. */
305 ptable_hints_store(MY_CXT.tbl, h, h);
306 #endif /* LT_THREADSAFE */
308 return newSViv(PTR2IV(h));
311 STATIC SV *lt_detag(pTHX_ const SV *hint) {
312 #define lt_detag(H) lt_detag(aTHX_ (H))
316 if (!(hint && SvIOK(hint)))
319 h = INT2PTR(lt_hint_t *, SvIVX(hint));
321 h = ptable_fetch(MY_CXT.tbl, h);
322 #endif /* LT_THREADSAFE */
323 #if LT_WORKAROUND_REQUIRE_PROPAGATION
324 if (lt_require_tag() != h->require_tag)
326 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
328 return LT_HINT_CODE(h);
331 STATIC U32 lt_hash = 0;
333 STATIC SV *lt_hint(pTHX) {
334 #define lt_hint() lt_hint(aTHX)
336 #if LT_HAS_PERL(5, 9, 5)
337 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
339 __PACKAGE__, __PACKAGE_LEN__,
343 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
348 return lt_detag(hint);
351 /* ... op => info map ...................................................... */
353 #define PTABLE_NAME ptable_map
354 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
358 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
359 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
361 STATIC ptable *lt_op_map = NULL;
364 STATIC perl_mutex lt_op_map_mutex;
369 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
371 #else /* MULTIPLICITY */
375 #endif /* !MULTIPLICITY */
376 OP *(*old_pp_padsv)(pTHX);
379 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
380 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
384 MUTEX_LOCK(<_op_map_mutex);
387 if (!(oi = ptable_fetch(lt_op_map, o))) {
388 oi = PerlMemShared_malloc(sizeof *oi);
389 ptable_map_store(lt_op_map, o, oi);
393 #else /* MULTIPLICITY */
395 SvREFCNT_dec(oi->orig_pkg);
396 SvREFCNT_dec(oi->type_pkg);
397 SvREFCNT_dec(oi->type_meth);
398 #endif /* !MULTIPLICITY */
403 STRLEN op_len = SvCUR(orig_pkg);
404 STRLEN tp_len = SvCUR(type_pkg);
405 STRLEN tm_len = SvCUR(type_meth);
406 STRLEN new_buf_size = op_len + tp_len + tm_len;
408 if (new_buf_size > oi->buf_size) {
409 PerlMemShared_free(oi->buf);
410 oi->buf = PerlMemShared_malloc(new_buf_size);
411 oi->buf_size = new_buf_size;
414 Copy(SvPVX(orig_pkg), buf, op_len, char);
416 Copy(SvPVX(type_pkg), buf, tp_len, char);
418 Copy(SvPVX(type_meth), buf, tm_len, char);
419 oi->orig_pkg_len = op_len;
420 oi->type_pkg_len = tp_len;
421 oi->type_meth_len = tm_len;
422 SvREFCNT_dec(orig_pkg);
423 SvREFCNT_dec(type_pkg);
424 SvREFCNT_dec(type_meth);
426 #else /* MULTIPLICITY */
427 oi->orig_pkg = orig_pkg;
428 oi->type_pkg = type_pkg;
429 oi->type_meth = type_meth;
430 #endif /* !MULTIPLICITY */
432 oi->old_pp_padsv = old_pp_padsv;
435 MUTEX_UNLOCK(<_op_map_mutex);
439 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
440 const lt_op_info *val;
443 MUTEX_LOCK(<_op_map_mutex);
446 val = ptable_fetch(lt_op_map, o);
453 MUTEX_UNLOCK(<_op_map_mutex);
459 STATIC void lt_map_delete(pTHX_ const OP *o) {
460 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
462 MUTEX_LOCK(<_op_map_mutex);
465 ptable_map_store(lt_op_map, o, NULL);
468 MUTEX_UNLOCK(<_op_map_mutex);
472 /* --- Hooks --------------------------------------------------------------- */
474 /* ... Our pp_padsv ........................................................ */
476 STATIC OP *lt_pp_padsv(pTHX) {
479 if ((PL_op->op_private & OPpLVAL_INTRO) && lt_map_fetch(PL_op, &oi)) {
480 PADOFFSET targ = PL_op->op_targ;
481 SV *sv = PAD_SVl(targ);
484 SV *orig_pkg, *type_pkg, *type_meth;
493 STRLEN op_len = oi.orig_pkg_len, tp_len = oi.type_pkg_len;
495 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
496 SvREADONLY_on(orig_pkg);
498 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
499 SvREADONLY_on(type_pkg);
501 type_meth = sv_2mortal(newSVpvn(buf, oi.type_meth_len));
502 SvREADONLY_on(type_meth);
504 #else /* MULTIPLICITY */
505 orig_pkg = oi.orig_pkg;
506 type_pkg = oi.type_pkg;
507 type_meth = oi.type_meth;
508 #endif /* !MULTIPLICITY */
517 items = call_sv(type_meth, G_ARRAY | G_METHOD);
527 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
535 return CALL_FPTR(oi.old_pp_padsv)(aTHX);
538 return CALL_FPTR(PL_ppaddr[OP_PADSV])(aTHX);
541 STATIC void lt_pp_padsv_save(pMY_CXT) {
542 #define lt_pp_padsv_save() lt_pp_padsv_save(aMY_CXT)
543 if (MY_CXT.pp_padsv_saved)
546 MY_CXT.pp_padsv_saved = PL_ppaddr[OP_PADSV];
547 PL_ppaddr[OP_PADSV] = lt_pp_padsv;
550 STATIC void lt_pp_padsv_restore(pMY_CXT_ OP *o) {
551 #define lt_pp_padsv_restore(O) lt_pp_padsv_restore(aMY_CXT_ (O))
552 OP *(*saved)(pTHX) = MY_CXT.pp_padsv_saved;
557 if (o->op_ppaddr == lt_pp_padsv)
558 o->op_ppaddr = saved;
560 PL_ppaddr[OP_PADSV] = saved;
561 MY_CXT.pp_padsv_saved = 0;
564 /* ... Our ck_pad{any,sv} .................................................. */
566 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
567 * function, but are instead manually mutated from a PADANY. This is why we set
568 * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
569 * their pp_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
570 * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
571 * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
574 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
576 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
581 lt_pp_padsv_restore(o);
583 o = CALL_FPTR(lt_old_ck_padany)(aTHX_ o);
585 stash = PL_in_my_stash;
586 if (stash && (code = lt_hint())) {
587 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
588 SV *orig_meth = MY_CXT.default_meth;
590 SV *type_meth = NULL;
595 SvREADONLY_on(orig_pkg);
606 items = call_sv(code, G_ARRAY);
610 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
612 SvREFCNT_dec(orig_pkg);
621 type_meth = newSVsv(rsv);
622 SvREADONLY_on(type_meth);
627 type_pkg = newSVsv(rsv);
628 SvREADONLY_on(type_pkg);
638 SvREFCNT_inc(orig_pkg);
642 type_meth = orig_meth;
643 SvREFCNT_inc(orig_meth);
648 lt_map_store(o, orig_pkg, type_pkg, type_meth, MY_CXT.pp_padsv_saved);
657 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
659 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
662 lt_pp_padsv_restore(o);
666 return CALL_FPTR(lt_old_ck_padsv)(aTHX_ o);
669 STATIC U32 lt_initialized = 0;
671 STATIC void lt_teardown(pTHX_ void *root) {
683 ptable_hints_free(MY_CXT.tbl);
685 SvREFCNT_dec(MY_CXT.default_meth);
687 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_old_ck_padany);
688 lt_old_ck_padany = 0;
689 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_old_ck_padsv);
695 STATIC void lt_setup(pTHX) {
696 #define lt_setup() lt_setup(aTHX)
703 MY_CXT.tbl = ptable_new();
706 MY_CXT.pp_padsv_saved = 0;
707 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
708 SvREADONLY_on(MY_CXT.default_meth);
711 lt_old_ck_padany = PL_check[OP_PADANY];
712 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
713 lt_old_ck_padsv = PL_check[OP_PADSV];
714 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_ck_padsv);
717 call_atexit(lt_teardown, aTHX);
719 call_atexit(lt_teardown, NULL);
725 STATIC U32 lt_booted = 0;
727 /* --- XS ------------------------------------------------------------------ */
729 MODULE = Lexical::Types PACKAGE = Lexical::Types
738 lt_op_map = ptable_new();
740 MUTEX_INIT(<_op_map_mutex);
743 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
745 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
746 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
759 SV *cloned_default_meth;
764 ud.tbl = t = ptable_new();
765 ud.owner = MY_CXT.owner;
766 ptable_walk(MY_CXT.tbl, lt_ptable_hints_clone, &ud);
767 cloned_default_meth = lt_clone(MY_CXT.default_meth, MY_CXT.owner);
773 MY_CXT.pp_padsv_saved = 0;
774 MY_CXT.default_meth = cloned_default_meth;
776 reap(3, lt_thread_cleanup, NULL);
785 RETVAL = lt_tag(value);