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