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