Types.xs

   1 /* This file is part of the Lexical-Types Perl module.
   2  * See http://search.cpan.org/dist/Lexical-Types/ */
   3
   4 #define PERL_NO_GET_CONTEXT
   5 #include "EXTERN.h"
   6 #include "perl.h"
   7 #include "XSUB.h"
   8
   9 #define __PACKAGE__     "Lexical::Types"
  10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
  11
  12 /* --- Compatibility wrappers ---------------------------------------------- */
  13
  14 #define LT_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  15
  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
  19 # endif
  20 #else
  21 # ifndef PL_in_my_stash
  22 #  define PL_in_my_stash PL_Iin_my_stash
  23 # endif
  24 #endif
  25
  26 #ifndef HvNAME_get
  27 # define HvNAME_get(H) HvNAME(H)
  28 #endif
  29
  30 #ifndef HvNAMELEN_get
  31 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
  32 #endif
  33
  34 #ifndef SvIS_FREED
  35 # define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
  36 #endif
  37
  38 /* ... Thread safety and multiplicity ...................................... */
  39
  40 #ifndef LT_MULTIPLICITY
  41 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  42 #  define LT_MULTIPLICITY 1
  43 # else
  44 #  define LT_MULTIPLICITY 0
  45 # endif
  46 #endif
  47 #if LT_MULTIPLICITY && !defined(tTHX)
  48 # define tTHX PerlInterpreter*
  49 #endif
  50
  51 #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))
  52 # define LT_THREADSAFE 1
  53 # ifndef MY_CXT_CLONE
  54 #  define MY_CXT_CLONE \
  55     dMY_CXT_SV;                                                      \
  56     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  57     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  58     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  59 # endif
  60 #else
  61 # define LT_THREADSAFE 0
  62 #endif
  63
  64 /* --- Helpers ------------------------------------------------------------- */
  65
  66 /* ... Thread-safe hints ................................................... */
  67
  68 #if LT_THREADSAFE
  69
  70 #define PTABLE_NAME        ptable_hints
  71 #define PTABLE_VAL_FREE(V) if ((V) && !SvIS_FREED((SV *) (V))) SvREFCNT_dec(V)
  72
  73 #define pPTBL  pTHX
  74 #define pPTBL_ pTHX_
  75 #define aPTBL  aTHX
  76 #define aPTBL_ aTHX_
  77
  78 #include "ptable.h"
  79
  80 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
  81 #define ptable_hints_free(T)        ptable_hints_free(aTHX_ (T))
  82
  83 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
  84
  85 typedef struct {
  86  ptable *tbl;
  87  tTHX    owner;
  88 } my_cxt_t;
  89
  90 START_MY_CXT
  91
  92 STATIC void lt_ptable_hints_clone(pTHX_ ptable_ent *ent, void *ud_) {
  93  my_cxt_t *ud  = ud_;
  94  SV       *val = ent->val;
  95
  96  if (ud->owner != aTHX) {
  97   CLONE_PARAMS param;
  98   AV *stashes = (SvTYPE(val) == SVt_PVHV && HvNAME_get(val)) ? newAV() : NULL;
  99   param.stashes    = stashes;
 100   param.flags      = 0;
 101   param.proto_perl = ud->owner;
 102   val = sv_dup(val, &param);
 103   if (stashes) {
 104    av_undef(stashes);
 105    SvREFCNT_dec(stashes);
 106   }
 107  }
 108
 109  ptable_hints_store(ud->tbl, ent->key, val);
 110  SvREFCNT_inc(val);
 111 }
 112
 113 STATIC void lt_thread_cleanup(pTHX_ void *);
 114
 115 STATIC void lt_thread_cleanup(pTHX_ void *ud) {
 116  int *level = ud;
 117  SV  *id;
 118
 119  if (*level) {
 120   *level = 0;
 121   LEAVE;
 122   SAVEDESTRUCTOR_X(lt_thread_cleanup, level);
 123   ENTER;
 124  } else {
 125   dMY_CXT;
 126   PerlMemShared_free(level);
 127   ptable_hints_free(MY_CXT.tbl);
 128  }
 129 }
 130
 131 STATIC SV *lt_tag(pTHX_ SV *value) {
 132 #define lt_tag(V) lt_tag(aTHX_ (V))
 133  dMY_CXT;
 134
 135  value = SvOK(value) && SvROK(value) ? SvRV(value) : NULL;
 136  /* We only need for the key to be an unique tag for looking up the value later.
 137   * Allocated memory provides convenient unique identifiers, so that's why we
 138   * use the value pointer as the key itself. */
 139  ptable_hints_store(MY_CXT.tbl, value, value);
 140  SvREFCNT_inc(value);
 141
 142  return newSVuv(PTR2UV(value));
 143 }
 144
 145 STATIC SV *lt_detag(pTHX_ const SV *hint) {
 146 #define lt_detag(H) lt_detag(aTHX_ (H))
 147  void *tag;
 148  SV   *value;
 149
 150  if (!hint || !SvOK(hint) || !SvIOK(hint))
 151   croak("Wrong hint");
 152
 153  tag = INT2PTR(void *, SvIVX(hint));
 154  {
 155   dMY_CXT;
 156   value = ptable_fetch(MY_CXT.tbl, tag);
 157  }
 158
 159  return value;
 160 }
 161
 162 #else
 163
 164 STATIC SV *lt_tag(pTHX_ SV *value) {
 165 #define lt_tag(V) lt_tag(aTHX_ (V))
 166  UV tag = 0;
 167
 168  if (SvOK(value) && SvROK(value)) {
 169   value = SvRV(value);
 170   SvREFCNT_inc(value);
 171   tag = PTR2UV(value);
 172  }
 173
 174  return newSVuv(tag);
 175 }
 176
 177 #define lt_detag(H) INT2PTR(SV *, SvUVX(H))
 178
 179 #endif /* LT_THREADSAFE */
 180
 181 STATIC U32 lt_hash = 0;
 182
 183 STATIC SV *lt_hint(pTHX) {
 184 #define lt_hint() lt_hint(aTHX)
 185  SV *id;
 186 #if LT_HAS_PERL(5, 10, 0)
 187  id = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
 188                                      NULL,
 189                                      __PACKAGE__, __PACKAGE_LEN__,
 190                                      0,
 191                                      lt_hash);
 192 #else
 193  SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, lt_hash);
 194  if (!val)
 195   return 0;
 196  id = *val;
 197 #endif
 198  return (id && SvOK(id)) ? id : NULL;
 199 }
 200
 201 /* ... op => info map ...................................................... */
 202
 203 #define PTABLE_NAME        ptable_map
 204 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
 205
 206 #include "ptable.h"
 207
 208 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
 209 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
 210
 211 STATIC ptable *lt_op_map = NULL;
 212
 213 #ifdef USE_ITHREADS
 214 STATIC perl_mutex lt_op_map_mutex;
 215 #endif
 216
 217 typedef struct {
 218  SV *orig_pkg;
 219  SV *type_pkg;
 220  SV *type_meth;
 221  OP *(*pp_padsv)(pTHX);
 222 } lt_op_info;
 223
 224 STATIC void lt_map_store(pPTBLMS_ const OP *o, SV *orig_pkg, SV *type_pkg, SV *type_meth, OP *(*pp_padsv)(pTHX)) {
 225 #define lt_map_store(O, OP, TP, TM, PP) lt_map_store(aPTBLMS_ (O), (OP), (TP), (TM), (PP))
 226  lt_op_info *oi;
 227
 228 #ifdef USE_ITHREADS
 229  MUTEX_LOCK(&lt_op_map_mutex);
 230 #endif
 231
 232  if (!(oi = ptable_fetch(lt_op_map, o))) {
 233   oi = PerlMemShared_malloc(sizeof *oi);
 234   ptable_map_store(lt_op_map, o, oi);
 235  }
 236
 237  oi->orig_pkg  = orig_pkg;
 238  oi->type_pkg  = type_pkg;
 239  oi->type_meth = type_meth;
 240  oi->pp_padsv  = pp_padsv;
 241
 242 #ifdef USE_ITHREADS
 243  MUTEX_UNLOCK(&lt_op_map_mutex);
 244 #endif
 245 }
 246
 247 STATIC const lt_op_info *lt_map_fetch(const OP *o, lt_op_info *oi) {
 248  const lt_op_info *val;
 249
 250 #ifdef USE_ITHREADS
 251  MUTEX_LOCK(&lt_op_map_mutex);
 252 #endif
 253
 254  val = ptable_fetch(lt_op_map, o);
 255  if (val) {
 256   *oi = *val;
 257   val = oi;
 258  }
 259
 260 #ifdef USE_ITHREADS
 261  MUTEX_UNLOCK(&lt_op_map_mutex);
 262 #endif
 263
 264  return val;
 265 }
 266
 267 /* --- Hooks --------------------------------------------------------------- */
 268
 269 /* ... Our pp_padsv ........................................................ */
 270
 271 STATIC OP *lt_pp_padsv(pTHX) {
 272  lt_op_info oi;
 273
 274  if ((PL_op->op_private & OPpLVAL_INTRO) && lt_map_fetch(PL_op, &oi)) {
 275   PADOFFSET targ = PL_op->op_targ;
 276   SV *sv         = PAD_SVl(targ);
 277
 278   if (sv) {
 279    int items;
 280    dSP;
 281
 282    ENTER;
 283    SAVETMPS;
 284
 285    PUSHMARK(SP);
 286    EXTEND(SP, 3);
 287    PUSHs(oi.type_pkg);
 288    PUSHs(sv);
 289    PUSHs(oi.orig_pkg);
 290    PUTBACK;
 291
 292    items = call_sv(oi.type_meth, G_ARRAY | G_METHOD);
 293
 294    SPAGAIN;
 295    switch (items) {
 296     case 0:
 297      break;
 298     case 1:
 299      sv_setsv(sv, POPs);
 300      break;
 301     default:
 302      croak("Typed scalar initializer method should return zero or one scalar, but got %d", items);
 303    }
 304    PUTBACK;
 305
 306    FREETMPS;
 307    LEAVE;
 308   }
 309
 310   return CALL_FPTR(oi.pp_padsv)(aTHX);
 311  }
 312
 313  return CALL_FPTR(PL_ppaddr[OP_PADSV])(aTHX);
 314 }
 315
 316 STATIC OP *(*lt_pp_padsv_saved)(pTHX) = 0;
 317
 318 STATIC void lt_pp_padsv_save(void) {
 319  if (lt_pp_padsv_saved)
 320   return;
 321
 322  lt_pp_padsv_saved   = PL_ppaddr[OP_PADSV];
 323  PL_ppaddr[OP_PADSV] = lt_pp_padsv;
 324 }
 325
 326 STATIC void lt_pp_padsv_restore(OP *o) {
 327  if (!lt_pp_padsv_saved)
 328   return;
 329
 330  if (o->op_ppaddr == lt_pp_padsv)
 331   o->op_ppaddr = lt_pp_padsv_saved;
 332
 333  PL_ppaddr[OP_PADSV] = lt_pp_padsv_saved;
 334  lt_pp_padsv_saved   = 0;
 335 }
 336
 337 /* ... Our ck_pad{any,sv} .................................................. */
 338
 339 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
 340  * function, but are instead manually mutated from a PADANY. This is why we set
 341  * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
 342  * their pp_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
 343  * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
 344  * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
 345  * globally. */
 346
 347 STATIC SV *lt_default_meth = NULL;
 348
 349 STATIC OP *(*lt_old_ck_padany)(pTHX_ OP *) = 0;
 350
 351 STATIC OP *lt_ck_padany(pTHX_ OP *o) {
 352  HV *stash;
 353  SV *hint;
 354
 355  lt_pp_padsv_restore(o);
 356
 357  o = CALL_FPTR(lt_old_ck_padany)(aTHX_ o);
 358
 359  stash = PL_in_my_stash;
 360  if (stash && (hint = lt_hint())) {
 361   SV *orig_pkg  = newSVpvn(HvNAME_get(stash), HvNAMELEN_get(stash));
 362   SV *orig_meth = lt_default_meth;
 363   SV *type_pkg  = NULL;
 364   SV *type_meth = NULL;
 365   SV *code      = lt_detag(hint);
 366
 367   SvREADONLY_on(orig_pkg);
 368
 369   if (code) {
 370    int items;
 371    dSP;
 372
 373    ENTER;
 374    SAVETMPS;
 375
 376    PUSHMARK(SP);
 377    EXTEND(SP, 2);
 378    PUSHs(orig_pkg);
 379    PUSHs(orig_meth);
 380    PUTBACK;
 381
 382    items = call_sv(code, G_ARRAY);
 383
 384    SPAGAIN;
 385    if (items > 2)
 386     croak(__PACKAGE__ " mangler should return zero, one or two scalars, but got %d", items);
 387    if (items == 0) {
 388     SvREFCNT_dec(orig_pkg);
 389     goto skip;
 390    } else {
 391     SV *rsv;
 392     if (items > 1) {
 393      rsv = POPs;
 394      if (SvOK(rsv)) {
 395       type_meth = newSVsv(rsv);
 396       SvREADONLY_on(type_meth);
 397      }
 398     }
 399     rsv = POPs;
 400     if (SvOK(rsv)) {
 401      type_pkg = newSVsv(rsv);
 402      SvREADONLY_on(type_pkg);
 403     }
 404    }
 405    PUTBACK;
 406
 407    FREETMPS;
 408    LEAVE;
 409   }
 410
 411   if (!type_pkg) {
 412    type_pkg = orig_pkg;
 413    SvREFCNT_inc(orig_pkg);
 414   }
 415
 416   if (!type_meth) {
 417    type_meth = orig_meth;
 418    SvREFCNT_inc(orig_meth);
 419   }
 420
 421   lt_pp_padsv_save();
 422
 423   lt_map_store(o, orig_pkg, type_pkg, type_meth, lt_pp_padsv_saved);
 424  }
 425
 426 skip:
 427  return o;
 428 }
 429
 430 STATIC OP *(*lt_old_ck_padsv)(pTHX_ OP *) = 0;
 431
 432 STATIC OP *lt_ck_padsv(pTHX_ OP *o) {
 433  lt_pp_padsv_restore(o);
 434
 435  return CALL_FPTR(lt_old_ck_padsv)(aTHX_ o);
 436 }
 437
 438 STATIC U32 lt_initialized = 0;
 439
 440 /* --- XS ------------------------------------------------------------------ */
 441
 442 MODULE = Lexical::Types      PACKAGE = Lexical::Types
 443
 444 PROTOTYPES: ENABLE
 445
 446 BOOT:
 447 {
 448  if (!lt_initialized++) {
 449   HV *stash;
 450 #if LT_THREADSAFE
 451   MY_CXT_INIT;
 452   MY_CXT.tbl   = ptable_new();
 453   MY_CXT.owner = aTHX;
 454 #endif
 455
 456   lt_op_map = ptable_new();
 457 #ifdef USE_ITHREADS
 458   MUTEX_INIT(&lt_op_map_mutex);
 459 #endif
 460
 461   lt_default_meth = newSVpvn("TYPEDSCALAR", 11);
 462   SvREADONLY_on(lt_default_meth);
 463
 464   PERL_HASH(lt_hash, __PACKAGE__, __PACKAGE_LEN__);
 465
 466   lt_old_ck_padany    = PL_check[OP_PADANY];
 467   PL_check[OP_PADANY] = MEMBER_TO_FPTR(lt_ck_padany);
 468   lt_old_ck_padsv     = PL_check[OP_PADSV];
 469   PL_check[OP_PADSV]  = MEMBER_TO_FPTR(lt_ck_padsv);
 470
 471   stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
 472   newCONSTSUB(stash, "LT_THREADSAFE", newSVuv(LT_THREADSAFE));
 473  }
 474 }
 475
 476 #if LT_THREADSAFE
 477
 478 void
 479 CLONE(...)
 480 PROTOTYPE: DISABLE
 481 PREINIT:
 482  ptable *t;
 483  int    *level;
 484 CODE:
 485  {
 486   my_cxt_t ud;
 487   dMY_CXT;
 488   ud.tbl   = t = ptable_new();
 489   ud.owner = MY_CXT.owner;
 490   ptable_walk(MY_CXT.tbl, lt_ptable_hints_clone, &ud);
 491  }
 492  {
 493   MY_CXT_CLONE;
 494   MY_CXT.tbl   = t;
 495   MY_CXT.owner = aTHX;
 496  }
 497  {
 498   level = PerlMemShared_malloc(sizeof *level);
 499   *level = 1;
 500   LEAVE;
 501   SAVEDESTRUCTOR_X(lt_thread_cleanup, level);
 502   ENTER;
 503  }
 504
 505 #endif
 506
 507 SV *
 508 _tag(SV *value)
 509 PROTOTYPE: $
 510 CODE:
 511  RETVAL = lt_tag(value);
 512 OUTPUT:
 513  RETVAL