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