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->cxreq = h1->cxreq;
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)
236 for (si = PL_curstackinfo; si; si = si->si_prev) {
239 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
240 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
242 if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE)
249 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
251 STATIC SV *lt_tag(pTHX_ SV *value) {
252 #define lt_tag(V) lt_tag(aTHX_ (V))
259 if (SvTYPE(value) >= SVt_PVCV) {
261 SvREFCNT_inc_simple_NN(code);
266 h = PerlMemShared_malloc(sizeof *h);
268 # if LT_WORKAROUND_REQUIRE_PROPAGATION
269 h->cxreq = lt_require_tag();
270 # endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
271 #else /* LT_HINT_STRUCT */
273 #endif /* !LT_HINT_STRUCT */
276 /* We only need for the key to be an unique tag for looking up the value later.
277 * Allocated memory provides convenient unique identifiers, so that's why we
278 * use the hint as the key itself. */
279 ptable_hints_store(MY_CXT.tbl, h, h);
280 #endif /* LT_THREADSAFE */
282 return newSViv(PTR2IV(h));
285 STATIC SV *lt_detag(pTHX_ const SV *hint) {
286 #define lt_detag(H) lt_detag(aTHX_ (H))
290 if (!(hint && SvIOK(hint)))
293 h = INT2PTR(lt_hint_t *, SvIVX(hint));
295 h = ptable_fetch(MY_CXT.tbl, h);
296 #endif /* LT_THREADSAFE */
297 #if LT_WORKAROUND_REQUIRE_PROPAGATION
298 if (lt_require_tag() != h->cxreq)
300 #endif /* LT_WORKAROUND_REQUIRE_PROPAGATION */
302 return LT_HINT_CODE(h);
305 STATIC U32 lt_hash = 0;
307 STATIC SV *lt_hint(pTHX) {
308 #define lt_hint() lt_hint(aTHX)
310 #if LT_HAS_PERL(5, 9, 5)
311 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
313 __PACKAGE__, __PACKAGE_LEN__,
317 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
322 return lt_detag(hint);
325 /* ... op => info map ...................................................... */
327 #define PTABLE_NAME ptable_map
328 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
332 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
333 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
335 STATIC ptable *lt_op_map = NULL;
338 STATIC perl_mutex lt_op_map_mutex;
343 STRLEN buf_size, orig_pkg_len, type_pkg_len, type_meth_len;
345 #else /* MULTIPLICITY */
349 #endif /* !MULTIPLICITY */
350 OP *(*old_pp_padsv)(pTHX);
353 STATIC void lt_map_store(pTHX_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*old_pp_padsv)(pTHX)) {
354 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aTHX_ (O), (OP), (TP), (TM), (PP))
358 MUTEX_LOCK(<_op_map_mutex);
361 if (!(oi = ptable_fetch(lt_op_map, o))) {
362 oi = PerlMemShared_malloc(sizeof *oi);
363 ptable_map_store(lt_op_map, o, oi);
367 #else /* MULTIPLICITY */
369 SvREFCNT_dec(oi->orig_pkg);
370 SvREFCNT_dec(oi->type_pkg);
371 SvREFCNT_dec(oi->type_meth);
372 #endif /* !MULTIPLICITY */
377 STRLEN op_len = SvCUR(orig_pkg);
378 STRLEN tp_len = SvCUR(type_pkg);
379 STRLEN tm_len = SvCUR(type_meth);
380 STRLEN new_buf_size = op_len + tp_len + tm_len;
382 if (new_buf_size > oi->buf_size) {
383 PerlMemShared_free(oi->buf);
384 oi->buf = PerlMemShared_malloc(new_buf_size);
385 oi->buf_size = new_buf_size;
388 Copy(SvPVX(orig_pkg), buf, op_len, char);
390 Copy(SvPVX(type_pkg), buf, tp_len, char);
392 Copy(SvPVX(type_meth), buf, tm_len, char);
393 oi->orig_pkg_len = op_len;
394 oi->type_pkg_len = tp_len;
395 oi->type_meth_len = tm_len;
396 SvREFCNT_dec(orig_pkg);
397 SvREFCNT_dec(type_pkg);
398 SvREFCNT_dec(type_meth);
400 #else /* MULTIPLICITY */
401 oi->orig_pkg = orig_pkg;
402 oi->type_pkg = type_pkg;
403 oi->type_meth = type_meth;
404 #endif /* !MULTIPLICITY */
406 oi->old_pp_padsv = old_pp_padsv;
409 MUTEX_UNLOCK(<_op_map_mutex);
413 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
414 const lt_op_info *val;
417 MUTEX_LOCK(<_op_map_mutex);
420 val = ptable_fetch(lt_op_map, o);
427 MUTEX_UNLOCK(<_op_map_mutex);
433 STATIC void lt_map_delete(pTHX_ const OP *o) {
434 #define lt_map_delete(O) lt_map_delete(aTHX_ (O))
436 MUTEX_LOCK(<_op_map_mutex);
439 ptable_map_store(lt_op_map, o, NULL);
442 MUTEX_UNLOCK(<_op_map_mutex);
446 /* --- Hooks --------------------------------------------------------------- */
448 /* ... Our pp_padsv ........................................................ */
450 STATIC OP *lt_pp_padsv(pTHX) {
453 if ((PL_op->op_private & OPpLVAL_INTRO) && lt_map_fetch(PL_op, &oi)) {
454 PADOFFSET targ = PL_op->op_targ;
455 SV *sv = PAD_SVl(targ);
458 SV *orig_pkg, *type_pkg, *type_meth;
467 STRLEN op_len = oi.orig_pkg_len, tp_len = oi.type_pkg_len;
469 orig_pkg = sv_2mortal(newSVpvn(buf, op_len));
470 SvREADONLY_on(orig_pkg);
472 type_pkg = sv_2mortal(newSVpvn(buf, tp_len));
473 SvREADONLY_on(type_pkg);
475 type_meth = sv_2mortal(newSVpvn(buf, oi.type_meth_len));
476 SvREADONLY_on(type_meth);
478 #else /* MULTIPLICITY */
479 orig_pkg = oi.orig_pkg;
480 type_pkg = oi.type_pkg;
481 type_meth = oi.type_meth;
482 #endif /* !MULTIPLICITY */
491 items = call_sv(type_meth, G_ARRAY | G_METHOD);
501 croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
509 return CALL_FPTR(oi.old_pp_padsv)(aTHX);
512 return CALL_FPTR(PL_ppaddr[OP_PADSV])(aTHX);
515 STATIC void lt_pp_padsv_save(pMY_CXT) {
516 #define lt_pp_padsv_save() lt_pp_padsv_save(aMY_CXT)
517 if (MY_CXT.pp_padsv_saved)
520 MY_CXT.pp_padsv_saved = PL_ppaddr[OP_PADSV];
521 PL_ppaddr[OP_PADSV] = lt_pp_padsv;
524 STATIC void lt_pp_padsv_restore(pMY_CXT_ OP *o) {
525 #define lt_pp_padsv_restore(O) lt_pp_padsv_restore(aMY_CXT_ (O))
526 OP *(*saved)(pTHX) = MY_CXT.pp_padsv_saved;
531 if (o->op_ppaddr == lt_pp_padsv)
532 o->op_ppaddr = saved;
534 PL_ppaddr[OP_PADSV] = saved;
535 MY_CXT.pp_padsv_saved = 0;
538 /* ... Our ck_pad{any,sv} .................................................. */
540 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
541 * function, but are instead manually mutated from a PADANY. This is why we set
542 * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
543 * their pp_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
544 * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
545 * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
548 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
550 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
555 lt_pp_padsv_restore(o);
557 o = CALL_FPTR(lt_old_ck_padany)(aTHX_ o);
559 stash = PL_in_my_stash;
560 if (stash && (code = lt_hint())) {
561 SV *orig_pkg = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
562 SV *orig_meth = MY_CXT.default_meth;
564 SV *type_meth = NULL;
569 SvREADONLY_on(orig_pkg);
580 items = call_sv(code, G_ARRAY);
584 croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
586 SvREFCNT_dec(orig_pkg);
595 type_meth = newSVsv(rsv);
596 SvREADONLY_on(type_meth);
601 type_pkg = newSVsv(rsv);
602 SvREADONLY_on(type_pkg);
612 SvREFCNT_inc(orig_pkg);
616 type_meth = orig_meth;
617 SvREFCNT_inc(orig_meth);
622 lt_map_store(o, orig_pkg, type_pkg, type_meth, MY_CXT.pp_padsv_saved);
631 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
633 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
636 lt_pp_padsv_restore(o);
640 return CALL_FPTR(lt_old_ck_padsv)(aTHX_ o);
643 STATIC U32 lt_initialized = 0;
645 STATIC void lt_teardown(pTHX_ void *root) {
657 ptable_hints_free(MY_CXT.tbl);
659 SvREFCNT_dec(MY_CXT.default_meth);
661 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_old_ck_padany);
662 lt_old_ck_padany = 0;
663 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_old_ck_padsv);
669 STATIC void lt_setup(pTHX) {
670 #define lt_setup() lt_setup(aTHX)
677 MY_CXT.tbl = ptable_new();
680 MY_CXT.pp_padsv_saved = 0;
681 MY_CXT.default_meth = newSVpvn("TYPEDSCALAR", 11);
682 SvREADONLY_on(MY_CXT.default_meth);
685 lt_old_ck_padany = PL_check[OP_PADANY];
686 PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
687 lt_old_ck_padsv = PL_check[OP_PADSV];
688 PL_check[OP_PADSV] = MEMBER_TO_FPTR(lt_ck_padsv);
691 call_atexit(lt_teardown, aTHX);
693 call_atexit(lt_teardown, NULL);
699 STATIC U32 lt_booted = 0;
701 /* --- XS ------------------------------------------------------------------ */
703 MODULE = Lexical::Types PACKAGE = Lexical::Types
712 lt_op_map = ptable_new();
714 MUTEX_INIT(<_op_map_mutex);
717 PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
719 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
720 newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
733 SV *cloned_default_meth;
738 ud.tbl = t = ptable_new();
739 ud.owner = MY_CXT.owner;
740 ptable_walk(MY_CXT.tbl, lt_ptable_hints_clone, &ud);
741 cloned_default_meth = lt_clone(MY_CXT.default_meth, MY_CXT.owner);
747 MY_CXT.pp_padsv_saved = 0;
748 MY_CXT.default_meth = cloned_default_meth;
750 reap(3, lt_thread_cleanup, NULL);
759 RETVAL = lt_tag(value);