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->pp      = 0;
 120  c->check   = 0;
 121  c->ud      = NULL;
 122
 123  return;
 124 }
 125
 126 void sub_op_register(pTHX_ const sub_op_config_t *c, U32 flags) {
 127  SV *key = newSViv(PTR2IV(c->pp));
 128
 129  if (!(flags & SUB_OP_REGISTER_STEAL))
 130   c = sub_op_dup(aTHX_ c);
 131
 132  if (!PL_custom_op_names)
 133   PL_custom_op_names = newHV();
 134  (void) hv_store_ent(PL_custom_op_names, key, newSVpv(c->name, c->namelen), 0);
 135
 136  if (!PL_custom_op_descs)
 137   PL_custom_op_descs = newHV();
 138  (void) hv_store_ent(PL_custom_op_descs, key, newSVpv(c->name, c->namelen), 0);
 139
 140  SvREFCNT_dec(key);
 141
 142  {
 143   dMY_CXT;
 144   (void) hv_store(MY_CXT.map, c->name, c->namelen, newSViv(PTR2IV(c)), 0);
 145  }
 146 }
 147
 148 sub_op_config_t *sub_op_dup(pTHX_ const sub_op_config_t *orig) {
 149  STRLEN len;
 150  sub_op_config_t *dupe = PerlMemShared_malloc(sizeof *dupe);
 151
 152  len           = orig->namelen;
 153  if (orig->name) {
 154   dupe->name   = PerlMemShared_malloc(len + 1);
 155   Copy(orig->name, dupe->name, len, char);
 156   ((char *) dupe->name)[len] = '\0';
 157  } else {
 158   dupe->name   = NULL;
 159  }
 160  dupe->namelen = len;
 161
 162
 163  dupe->pp    = orig->pp;
 164  dupe->check = orig->check;
 165  dupe->ud    = orig->ud;
 166
 167  return dupe;
 168 }
 169
 170 void sub_op_free(pTHX_ sub_op_config_t *c) {
 171  PerlMemShared_free((char *) c->name);
 172  PerlMemShared_free(c);
 173
 174  return;
 175 }
 176
 177 /* --- Private helpers ----------------------------------------------------- */
 178
 179 STATIC IV so_hint(pTHX) {
 180 #define so_hint() so_hint(aTHX)
 181  SV *hint;
 182
 183 #if SO_HAS_PERL(5, 9, 5)
 184  hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
 185                                        NULL,
 186                                        __PACKAGE__, __PACKAGE_LEN__,
 187                                        0,
 188                                        0);
 189 #else
 190  {
 191   SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
 192   if (!val)
 193    return 0;
 194   hint = *val;
 195  }
 196 #endif
 197
 198  return (SvOK(hint) && SvIOK(hint)) ? SvIVX(hint) : 0;
 199 }
 200
 201 STATIC OP *(*so_old_ck_entersub)(pTHX_ OP *) = 0;
 202
 203 STATIC OP *so_ck_entersub(pTHX_ OP *o) {
 204  o = CALL_FPTR(so_old_ck_entersub)(aTHX_ o);
 205
 206  if (so_hint()) {
 207   OP *ex_list, *rv2cv, *gvop, *last_arg = NULL;
 208   GV *gv;
 209
 210   if (o->op_type != OP_ENTERSUB)
 211    goto skip;
 212   if (o->op_private & OPpENTERSUB_AMPER) /* hopefully \&foo */
 213    goto skip;
 214
 215   ex_list = cUNOPo->op_first;
 216   /* pushmark when a method call */
 217   if (!ex_list || ex_list->op_type != OP_NULL)
 218    goto skip;
 219
 220   rv2cv = cUNOPx(ex_list)->op_first;
 221   if (!rv2cv)
 222    goto skip;
 223
 224   while (1) {
 225    OP *next = rv2cv->op_sibling;
 226    if (!next)
 227     break;
 228    last_arg = rv2cv;
 229    rv2cv    = next;
 230   }
 231
 232   if (!(rv2cv->op_flags & OPf_KIDS))
 233    goto skip;
 234
 235   gvop = cUNOPx(rv2cv)->op_first;
 236   if (!gvop || gvop->op_type != OP_GV)
 237    goto skip;
 238
 239   gv = cGVOPx_gv(gvop);
 240
 241   {
 242    SV **svp;
 243    CV  *cv = NULL;
 244    const char *name = GvNAME(gv);
 245    I32         len  = GvNAMELEN(gv);
 246    const sub_op_config_t *c;
 247    dMY_CXT;
 248
 249    svp = hv_fetch(MY_CXT.map, name, len, 0);
 250    if (!svp)
 251     goto skip;
 252
 253    c = INT2PTR(const sub_op_config_t *, SvIVX(*svp));
 254
 255    if (gv && SvTYPE(gv) >= SVt_PVGV && (cv = GvCV(gv)) == MY_CXT.placeholder) {
 256     SvREFCNT_dec(cv);
 257     GvCV(gv) = NULL;
 258    }
 259
 260    o->op_type   = OP_CUSTOM;
 261    o->op_ppaddr = c->pp;
 262
 263    if (last_arg)
 264     last_arg->op_sibling = NULL;
 265
 266    op_free(rv2cv);
 267
 268    if (c->check)
 269     o = CALL_FPTR(c->check)(aTHX_ o, c->ud);
 270
 271    {
 272     so_op_name_t *on = PerlMemShared_malloc(sizeof(*on) + len);
 273     Copy(name, &on->buf, len, char);
 274     (&on->buf)[len] = '\0';
 275     on->len = len;
 276 #ifdef USE_ITHREADS
 277     MUTEX_LOCK(&so_op_name_mutex);
 278 #endif /* USE_ITHREADS */
 279     ptable_store(so_op_name, o, on);
 280 #ifdef USE_ITHREADS
 281     MUTEX_UNLOCK(&so_op_name_mutex);
 282 #endif /* USE_ITHREADS */
 283    }
 284   }
 285  }
 286
 287 skip:
 288  return o;
 289 }
 290
 291 STATIC OP *(*so_old_ck_gelem)(pTHX_ OP *) = 0;
 292
 293 STATIC OP *so_ck_gelem(pTHX_ OP *o) {
 294  o = CALL_FPTR(so_old_ck_entersub)(aTHX_ o);
 295
 296  if (so_hint()) {
 297   OP *rv2gv, *gvop;
 298   GV *gv;
 299
 300   rv2gv = cUNOPo->op_first;
 301   if (!rv2gv)
 302    goto skip;
 303
 304   gvop = cUNOPx(rv2gv)->op_first;
 305   if (!gvop || gvop->op_type != OP_GV)
 306    goto skip;
 307
 308   gv = cGVOPx_gv(gvop);
 309   if (!gv)
 310    goto skip;
 311
 312   {
 313    CV *cv;
 314    dMY_CXT;
 315
 316    if (gv && SvTYPE(gv) >= SVt_PVGV && (cv = GvCV(gv)) == MY_CXT.placeholder) {
 317     SvREFCNT_dec(cv);
 318     GvCV(gv) = NULL;
 319    }
 320   }
 321  }
 322
 323 skip:
 324  return o;
 325 }
 326
 327 /* --- XS ------------------------------------------------------------------ */
 328
 329 MODULE = Sub::Op      PACKAGE = Sub::Op
 330
 331 PROTOTYPES: ENABLE
 332
 333 BOOT:
 334 {
 335  so_op_name = ptable_new();
 336 #ifdef USE_ITHREADS
 337  MUTEX_INIT(&so_op_name_mutex);
 338 #endif
 339
 340  MY_CXT_INIT;
 341  MY_CXT.map         = newHV();
 342  MY_CXT.placeholder = NULL;
 343 #if SO_THREADSAFE
 344  MY_CXT.owner       = aTHX;
 345 #endif /* SO_THREADSAFE */
 346
 347  so_old_ck_entersub    = PL_check[OP_ENTERSUB];
 348  PL_check[OP_ENTERSUB] = so_ck_entersub;
 349  so_old_ck_gelem       = PL_check[OP_GELEM];
 350  PL_check[OP_GELEM]    = so_ck_gelem;
 351 }
 352
 353 #if SO_THREADSAFE
 354
 355 void
 356 CLONE(...)
 357 PROTOTYPE: DISABLE
 358 PREINIT:
 359  HV  *map;
 360  CV  *placeholder;
 361  tTHX owner;
 362 PPCODE:
 363  {
 364   dMY_CXT;
 365   owner       = MY_CXT.owner;
 366   map         = (HV *) so_clone((SV *) MY_CXT.map,         owner);
 367   placeholder = (CV *) so_clone((SV *) MY_CXT.placeholder, owner);
 368  }
 369  {
 370   MY_CXT_CLONE;
 371   MY_CXT.map         = map;
 372   MY_CXT.placeholder = placeholder;
 373   MY_CXT.owner       = aTHX;
 374  }
 375  XSRETURN(0);
 376
 377 #endif /* SO_THREADSAFE */
 378
 379 void
 380 _placeholder(SV *sv)
 381 PROTOTYPE: $
 382 PPCODE:
 383  if (SvROK(sv)) {
 384   sv = SvRV(sv);
 385   if (SvTYPE(sv) >= SVt_PVCV) {
 386    dMY_CXT;
 387    SvREFCNT_dec(MY_CXT.placeholder);
 388    MY_CXT.placeholder = (CV *) SvREFCNT_inc(sv);
 389   }
 390  }
 391  XSRETURN(0);
 392
 393 void
 394 _custom_name(SV *op)
 395 PROTOTYPE: $
 396 PREINIT:
 397  OP *o;
 398  so_op_name_t *on;
 399 PPCODE:
 400  if (!SvROK(op))
 401   XSRETURN_UNDEF;
 402  o = INT2PTR(OP *, SvIV(SvRV(op)));
 403  if (!o || o->op_type != OP_CUSTOM)
 404   XSRETURN_UNDEF;
 405 #ifdef USE_ITHREADS
 406  MUTEX_LOCK(&so_op_name_mutex);
 407 #endif /* USE_ITHREADS */
 408  on = ptable_fetch(so_op_name, o);
 409 #ifdef USE_ITHREADS
 410  MUTEX_UNLOCK(&so_op_name_mutex);
 411 #endif /* USE_ITHREADS */
 412  if (!on)
 413   XSRETURN_UNDEF;
 414  ST(0) = sv_2mortal(newSVpvn(&on->buf, on->len));
 415  XSRETURN(1);
 416
 417 void
 418 _constant_sub(SV *sv)
 419 PROTOTYPE: $
 420 PPCODE:
 421  if (!SvROK(sv))
 422   XSRETURN_UNDEF;
 423  sv = SvRV(sv);
 424  if (SvTYPE(sv) < SVt_PVCV)
 425   XSRETURN_UNDEF;
 426  ST(0) = sv_2mortal(newSVuv(CvCONST(sv)));
 427  XSRETURN(1);