Op.xs

   1 /* This file is part of the Sub::Op Perl module.
   2  * See http://search.cpan.org/dist/Sub-Op/ */
   3
   4 #define PERL_NO_GET_CONTEXT
   5 #include "EXTERN.h"
   6 #include "perl.h"
   7 #include "XSUB.h"
   8
   9 #define __PACKAGE__     "Sub::Op"
  10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
  11
  12 /* --- Compatibility wrappers ---------------------------------------------- */
  13
  14 #define SO_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  15
  16 /* ... Thread safety and multiplicity ...................................... */
  17
  18 #ifndef SO_MULTIPLICITY
  19 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  20 #  define SO_MULTIPLICITY 1
  21 # else
  22 #  define SO_MULTIPLICITY 0
  23 # endif
  24 #endif
  25 #if SO_MULTIPLICITY && !defined(tTHX)
  26 # define tTHX PerlInterpreter*
  27 #endif
  28
  29 #if SO_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))
  30 # define SO_THREADSAFE 1
  31 # ifndef MY_CXT_CLONE
  32 #  define MY_CXT_CLONE \
  33     dMY_CXT_SV;                                                      \
  34     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  35     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  36     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  37 # endif
  38 #else
  39 # define SO_THREADSAFE 0
  40 # undef  dMY_CXT
  41 # define dMY_CXT      dNOOP
  42 # undef  MY_CXT
  43 # define MY_CXT       indirect_globaldata
  44 # undef  START_MY_CXT
  45 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  46 # undef  MY_CXT_INIT
  47 # define MY_CXT_INIT  NOOP
  48 # undef  MY_CXT_CLONE
  49 # define MY_CXT_CLONE NOOP
  50 #endif
  51
  52 /* --- Global data --------------------------------------------------------- */
  53
  54 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
  55
  56 typedef struct {
  57  HV  *map;
  58  CV  *placeholder;
  59 #if SO_THREADSAFE
  60  tTHX owner;
  61 #endif /* SO_THREADSAFE */
  62 } my_cxt_t;
  63
  64 START_MY_CXT
  65
  66 #if SO_THREADSAFE
  67
  68 STATIC SV *so_clone(pTHX_ SV *sv, tTHX owner) {
  69 #define so_clone(S, O) so_clone(aTHX_ (S), (O))
  70  CLONE_PARAMS  param;
  71  AV           *stashes = NULL;
  72  SV           *dupsv;
  73
  74  if (SvTYPE(sv) == SVt_PVHV && HvNAME_get(sv))
  75   stashes = newAV();
  76
  77  param.stashes    = stashes;
  78  param.flags      = 0;
  79  param.proto_perl = owner;
  80
  81  dupsv = sv_dup(sv, &param);
  82
  83  if (stashes) {
  84   av_undef(stashes);
  85   SvREFCNT_dec(stashes);
  86  }
  87
  88  return SvREFCNT_inc(dupsv);
  89 }
  90
  91 #endif /* SO_THREADSAFE */
  92
  93 #define PTABLE_NAME        ptable
  94 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
  95
  96 #include "ptable.h"
  97
  98 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
  99 #define ptable_store(T, K, V) ptable_store(aPTBLMS_ (T), (K), (V))
 100
 101 STATIC ptable *so_op_name = NULL;
 102
 103 #ifdef USE_ITHREADS
 104 STATIC perl_mutex so_op_name_mutex;
 105 #endif
 106
 107 typedef struct {
 108  STRLEN len;
 109  char   buf;
 110 } so_op_name_t;
 111
 112 /* --- Public API ---------------------------------------------------------- */
 113
 114 #include "sub_op.h"
 115
 116 void sub_op_init(sub_op_config_t *c) {
 117  c->name     = NULL;
 118  c->namelen  = 0;
 119  c->proto    = NULL;
 120  c->protolen = 0;
 121  c->pp       = 0;
 122  c->check    = 0;
 123  c->ref      = 0;
 124  c->ud       = NULL;
 125
 126  return;
 127 }
 128
 129 void sub_op_register(pTHX_ const sub_op_config_t *c, U32 flags) {
 130  SV *key = newSViv(PTR2IV(c->pp));
 131
 132  if (!(flags & SUB_OP_REGISTER_STEAL))
 133   c = sub_op_dup(aTHX_ c);
 134
 135  if (!PL_custom_op_names)
 136   PL_custom_op_names = newHV();
 137  (void) hv_store_ent(PL_custom_op_names, key, newSVpv(c->name, c->namelen), 0);
 138
 139  if (!PL_custom_op_descs)
 140   PL_custom_op_descs = newHV();
 141  (void) hv_store_ent(PL_custom_op_descs, key, newSVpv(c->name, c->namelen), 0);
 142
 143  SvREFCNT_dec(key);
 144
 145  {
 146   dMY_CXT;
 147   (void) hv_store(MY_CXT.map, c->name, c->namelen, newSViv(PTR2IV(c)), 0);
 148  }
 149 }
 150
 151 sub_op_config_t *sub_op_dup(pTHX_ const sub_op_config_t *orig) {
 152  STRLEN len;
 153  sub_op_config_t *dupe = PerlMemShared_malloc(sizeof *dupe);
 154
 155  len           = orig->namelen;
 156  if (orig->name) {
 157   dupe->name   = PerlMemShared_malloc(len + 1);
 158   Copy(orig->name, dupe->name, len, char);
 159   ((char *) dupe->name)[len] = '\0';
 160  } else {
 161   dupe->name   = NULL;
 162  }
 163  dupe->namelen = len;
 164
 165  len            = orig->protolen;
 166  if (orig->proto) {
 167   dupe->proto   = PerlMemShared_malloc(len + 1);
 168   Copy(orig->proto, dupe->proto, len, char);
 169   ((char *) dupe->proto)[len] = '\0';
 170  } else {
 171   dupe->proto   = NULL;
 172  }
 173  dupe->protolen = len;
 174
 175  dupe->pp    = orig->pp;
 176  dupe->check = orig->check;
 177  dupe->ref   = orig->ref;
 178  dupe->ud    = orig->ud;
 179
 180  return dupe;
 181 }
 182
 183 void sub_op_free(pTHX_ sub_op_config_t *c) {
 184  PerlMemShared_free((char *) c->name);
 185  PerlMemShared_free(c);
 186
 187  return;
 188 }
 189
 190 /* --- Private helpers ----------------------------------------------------- */
 191
 192 STATIC IV so_hint(pTHX) {
 193 #define so_hint() so_hint(aTHX)
 194  SV *hint;
 195
 196 #if SO_HAS_PERL(5, 9, 5)
 197  hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
 198                                        NULL,
 199                                        __PACKAGE__, __PACKAGE_LEN__,
 200                                        0,
 201                                        0);
 202 #else
 203  {
 204   SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
 205   if (!val)
 206    return 0;
 207   hint = *val;
 208  }
 209 #endif
 210
 211  return (SvOK(hint) && SvIOK(hint)) ? SvIVX(hint) : 0;
 212 }
 213
 214 STATIC OP *so_find_gvop(OP *o, OP **last_arg_p, OP **rv2cv_p) {
 215  OP *ex_list, *last_arg, *rv2cv, *gvop;
 216
 217  ex_list = cUNOPo->op_first;
 218  /* pushmark when a method call */
 219  if (!ex_list || ex_list->op_type != OP_NULL)
 220   goto skip;
 221
 222  rv2cv = cUNOPx(ex_list)->op_first;
 223  if (!rv2cv)
 224   goto skip;
 225
 226  while (1) {
 227   OP *next = rv2cv->op_sibling;
 228   if (!next)
 229    break;
 230   last_arg = rv2cv;
 231   rv2cv    = next;
 232  }
 233
 234  if (!(rv2cv->op_flags & OPf_KIDS))
 235   goto skip;
 236
 237  gvop = cUNOPx(rv2cv)->op_first;
 238
 239  if (gvop && gvop->op_type == OP_GV)
 240   goto done;
 241
 242 skip:
 243  last_arg = NULL;
 244  rv2cv    = NULL;
 245  gvop     = NULL;
 246
 247 done:
 248  if (last_arg_p)
 249   *last_arg_p = last_arg;
 250  if (rv2cv_p)
 251   *rv2cv_p    = rv2cv;
 252
 253  return gvop;
 254 }
 255
 256 STATIC OP *(*so_old_ck_entersub)(pTHX_ OP *) = 0;
 257
 258 STATIC OP *so_ck_entersub(pTHX_ OP *o) {
 259  o = CALL_FPTR(so_old_ck_entersub)(aTHX_ o);
 260
 261  if (so_hint()) {
 262   OP *ex_list, *last_arg, *rv2cv, *gvop;
 263   GV *gv;
 264
 265   if (o->op_type != OP_ENTERSUB)
 266    goto skip;
 267   if (o->op_private & OPpENTERSUB_AMPER) /* hopefully \&foo */
 268    goto skip;
 269
 270   gvop = so_find_gvop(o, &last_arg, &rv2cv);
 271   if (!gvop)
 272    goto skip;
 273
 274   gv = cGVOPx_gv(gvop);
 275
 276   {
 277    SV **svp;
 278    CV  *cv = NULL;
 279    const char *name = GvNAME(gv);
 280    I32         len  = GvNAMELEN(gv);
 281    const sub_op_config_t *c;
 282    dMY_CXT;
 283
 284    svp = hv_fetch(MY_CXT.map, name, len, 0);
 285    if (!svp)
 286     goto skip;
 287
 288    c = INT2PTR(const sub_op_config_t *, SvIVX(*svp));
 289
 290    if (gv && SvTYPE(gv) >= SVt_PVGV && (cv = GvCV(gv)) == MY_CXT.placeholder) {
 291     SvREFCNT_dec(cv);
 292     GvCV(gv) = NULL;
 293    }
 294
 295    o->op_type   = OP_CUSTOM;
 296    o->op_ppaddr = c->pp;
 297
 298    if (last_arg)
 299     last_arg->op_sibling = NULL;
 300
 301    op_free(rv2cv);
 302
 303    if (c->check)
 304     o = CALL_FPTR(c->check)(aTHX_ o, c->ud);
 305
 306    {
 307     so_op_name_t *on = PerlMemShared_malloc(sizeof(*on) + len);
 308     Copy(name, &on->buf, len, char);
 309     (&on->buf)[len] = '\0';
 310     on->len = len;
 311 #ifdef USE_ITHREADS
 312     MUTEX_LOCK(&so_op_name_mutex);
 313 #endif /* USE_ITHREADS */
 314     ptable_store(so_op_name, o, on);
 315 #ifdef USE_ITHREADS
 316     MUTEX_UNLOCK(&so_op_name_mutex);
 317 #endif /* USE_ITHREADS */
 318    }
 319   }
 320  }
 321
 322 skip:
 323  return o;
 324 }
 325
 326 STATIC OP *(*so_old_ck_refgen)(pTHX_ OP *) = 0;
 327
 328 STATIC OP *so_ck_refgen(pTHX_ OP *o) {
 329  o = CALL_FPTR(so_old_ck_refgen)(aTHX_ o);
 330
 331  if (so_hint()) {
 332   OP *kid    = o;
 333   OP *prev   = NULL;
 334   OP *parent = NULL;
 335
 336   while (kid->op_flags & OPf_KIDS) {
 337    parent = kid;
 338    kid    = cUNOPx(kid)->op_first;
 339   }
 340
 341   if (!parent)
 342    goto skip;
 343
 344   for (kid; kid; prev = kid, kid = kid->op_sibling) {
 345    OP *gvop;
 346    GV *gv;
 347    const sub_op_config_t *c;
 348
 349    if (kid->op_type != OP_RV2CV)
 350     continue;
 351
 352    gvop = so_find_gvop(kid, NULL, NULL);
 353    if (!gvop)
 354     continue;
 355
 356    gv = cGVOPx_gv(gvop);
 357
 358    {
 359     SV **svp;
 360     const char *name = GvNAME(gv);
 361     I32         len  = GvNAMELEN(gv);
 362     dMY_CXT;
 363
 364     svp = hv_fetch(MY_CXT.map, name, len, 0);
 365     if (!svp)
 366      continue;
 367
 368     c = INT2PTR(const sub_op_config_t *, SvIVX(*svp));
 369    }
 370
 371    if (c->ref) {
 372     OP *new_kid = CALL_FPTR(c->ref)(aTHX_ kid, c->ud);
 373
 374     if (new_kid != kid) {
 375      new_kid->op_sibling = kid->op_sibling;
 376      new_kid->op_next = new_kid;
 377      if (prev)
 378       prev->op_sibling = new_kid;
 379      else
 380       cUNOPx(parent)->op_first = new_kid;
 381      op_null(kid);
 382      kid = new_kid;
 383     }
 384    }
 385   }
 386  }
 387
 388 skip:
 389  return o;
 390 }
 391
 392 STATIC OP *(*so_old_ck_gelem)(pTHX_ OP *) = 0;
 393
 394 STATIC OP *so_ck_gelem(pTHX_ OP *o) {
 395  o = CALL_FPTR(so_old_ck_entersub)(aTHX_ o);
 396
 397  if (so_hint()) {
 398   OP *rv2gv, *gvop;
 399   GV *gv;
 400
 401   rv2gv = cUNOPo->op_first;
 402   if (!rv2gv)
 403    goto skip;
 404
 405   gvop = cUNOPx(rv2gv)->op_first;
 406   if (!gvop || gvop->op_type != OP_GV)
 407    goto skip;
 408
 409   gv = cGVOPx_gv(gvop);
 410   if (!gv)
 411    goto skip;
 412
 413   {
 414    CV *cv;
 415    dMY_CXT;
 416
 417    if (gv && SvTYPE(gv) >= SVt_PVGV && (cv = GvCV(gv)) == MY_CXT.placeholder) {
 418     SvREFCNT_dec(cv);
 419     GvCV(gv) = NULL;
 420    }
 421   }
 422  }
 423
 424 skip:
 425  return o;
 426 }
 427
 428 /* --- XS ------------------------------------------------------------------ */
 429
 430 MODULE = Sub::Op      PACKAGE = Sub::Op
 431
 432 PROTOTYPES: ENABLE
 433
 434 BOOT:
 435 {
 436  so_op_name = ptable_new();
 437 #ifdef USE_ITHREADS
 438  MUTEX_INIT(&so_op_name_mutex);
 439 #endif
 440
 441  MY_CXT_INIT;
 442  MY_CXT.map         = newHV();
 443  MY_CXT.placeholder = NULL;
 444 #if SO_THREADSAFE
 445  MY_CXT.owner       = aTHX;
 446 #endif /* SO_THREADSAFE */
 447
 448  so_old_ck_entersub    = PL_check[OP_ENTERSUB];
 449  PL_check[OP_ENTERSUB] = so_ck_entersub;
 450  so_old_ck_refgen      = PL_check[OP_REFGEN];
 451  PL_check[OP_REFGEN]   = so_ck_refgen;
 452  so_old_ck_gelem       = PL_check[OP_GELEM];
 453  PL_check[OP_GELEM]    = so_ck_gelem;
 454 }
 455
 456 #if SO_THREADSAFE
 457
 458 void
 459 CLONE(...)
 460 PROTOTYPE: DISABLE
 461 PREINIT:
 462  HV  *map;
 463  CV  *placeholder;
 464  tTHX owner;
 465 PPCODE:
 466  {
 467   dMY_CXT;
 468   owner       = MY_CXT.owner;
 469   map         = (HV *) so_clone((SV *) MY_CXT.map,         owner);
 470   placeholder = (CV *) so_clone((SV *) MY_CXT.placeholder, owner);
 471  }
 472  {
 473   MY_CXT_CLONE;
 474   MY_CXT.map         = map;
 475   MY_CXT.placeholder = placeholder;
 476   MY_CXT.owner       = aTHX;
 477  }
 478  XSRETURN(0);
 479
 480 #endif /* SO_THREADSAFE */
 481
 482 void
 483 _placeholder(SV *sv)
 484 PROTOTYPE: $
 485 PPCODE:
 486  if (SvROK(sv)) {
 487   sv = SvRV(sv);
 488   if (SvTYPE(sv) >= SVt_PVCV) {
 489    dMY_CXT;
 490    SvREFCNT_dec(MY_CXT.placeholder);
 491    MY_CXT.placeholder = (CV *) SvREFCNT_inc(sv);
 492   }
 493  }
 494  XSRETURN(0);
 495
 496 void
 497 _custom_name(SV *op)
 498 PROTOTYPE: $
 499 PREINIT:
 500  OP *o;
 501  so_op_name_t *on;
 502 PPCODE:
 503  if (!SvROK(op))
 504   XSRETURN_UNDEF;
 505  o = INT2PTR(OP *, SvIV(SvRV(op)));
 506  if (!o || o->op_type != OP_CUSTOM)
 507   XSRETURN_UNDEF;
 508 #ifdef USE_ITHREADS
 509  MUTEX_LOCK(&so_op_name_mutex);
 510 #endif /* USE_ITHREADS */
 511  on = ptable_fetch(so_op_name, o);
 512 #ifdef USE_ITHREADS
 513  MUTEX_UNLOCK(&so_op_name_mutex);
 514 #endif /* USE_ITHREADS */
 515  if (!on)
 516   XSRETURN_UNDEF;
 517  ST(0) = sv_2mortal(newSVpvn(&on->buf, on->len));
 518  XSRETURN(1);
 519
 520 void
 521 _constant_sub(SV *sv)
 522 PROTOTYPE: $
 523 PPCODE:
 524  if (!SvROK(sv))
 525   XSRETURN_UNDEF;
 526  sv = SvRV(sv);
 527  if (SvTYPE(sv) < SVt_PVCV)
 528   XSRETURN_UNDEF;
 529  ST(0) = sv_2mortal(newSVuv(CvCONST(sv)));
 530  XSRETURN(1);
 531
 532 SV *
 533 _get_prototype(SV *name)
 534 PROTOTYPE: $
 535 PREINIT:
 536  HE *he;
 537  const sub_op_config_t *c;
 538 PPCODE:
 539  dMY_CXT;
 540  he = hv_fetch_ent(MY_CXT.map, name, 0, 0);
 541  if (!he)
 542   XSRETURN_UNDEF;
 543  c = INT2PTR(const sub_op_config_t *, SvIVX(HeVAL(he)));
 544  if (!c->proto)
 545   XSRETURN_UNDEF;
 546  ST(0) = sv_2mortal(newSVpvn(c->proto, c->protolen));
 547  XSRETURN(1);