indirect.xs

   1 /* This file is part of the indirect Perl module.
   2  * See http://search.cpan.org/dist/indirect/ */
   3
   4 #define PERL_NO_GET_CONTEXT
   5 #include "EXTERN.h"
   6 #include "perl.h"
   7 #include "XSUB.h"
   8
   9 #define __PACKAGE__     "indirect"
  10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
  11
  12 /* --- Compatibility wrappers ---------------------------------------------- */
  13
  14 #ifndef NOOP
  15 # define NOOP
  16 #endif
  17
  18 #ifndef dNOOP
  19 # define dNOOP
  20 #endif
  21
  22 #ifndef SvPV_const
  23 # define SvPV_const SvPV
  24 #endif
  25
  26 #ifndef SvPV_nolen_const
  27 # define SvPV_nolen_const SvPV_nolen
  28 #endif
  29
  30 #ifndef SvPVX_const
  31 # define SvPVX_const SvPVX
  32 #endif
  33
  34 #ifndef sv_catpvn_nomg
  35 # define sv_catpvn_nomg sv_catpvn
  36 #endif
  37
  38 #ifndef HvNAME_get
  39 # define HvNAME_get(H) HvNAME(H)
  40 #endif
  41
  42 #ifndef HvNAMELEN_get
  43 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
  44 #endif
  45
  46 #ifndef SvIS_FREED
  47 # define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
  48 #endif
  49
  50 #define I_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  51
  52 #if I_HAS_PERL(5, 10, 0) || defined(PL_parser)
  53 # ifndef PL_lex_inwhat
  54 #  define PL_lex_inwhat PL_parser->lex_inwhat
  55 # endif
  56 # ifndef PL_linestr
  57 #  define PL_linestr PL_parser->linestr
  58 # endif
  59 # ifndef PL_bufptr
  60 #  define PL_bufptr PL_parser->bufptr
  61 # endif
  62 # ifndef PL_oldbufptr
  63 #  define PL_oldbufptr PL_parser->oldbufptr
  64 # endif
  65 #else
  66 # ifndef PL_lex_inwhat
  67 #  define PL_lex_inwhat PL_Ilex_inwhat
  68 # endif
  69 # ifndef PL_linestr
  70 #  define PL_linestr PL_Ilinestr
  71 # endif
  72 # ifndef PL_bufptr
  73 #  define PL_bufptr PL_Ibufptr
  74 # endif
  75 # ifndef PL_oldbufptr
  76 #  define PL_oldbufptr PL_Ioldbufptr
  77 # endif
  78 #endif
  79
  80 /* ... Thread safety and multiplicity ...................................... */
  81
  82 #ifndef I_MULTIPLICITY
  83 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  84 #  define I_MULTIPLICITY 1
  85 # else
  86 #  define I_MULTIPLICITY 0
  87 # endif
  88 #endif
  89 #if I_MULTIPLICITY && !defined(tTHX)
  90 # define tTHX PerlInterpreter*
  91 #endif
  92
  93 #if I_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))
  94 # define I_THREADSAFE 1
  95 # ifndef MY_CXT_CLONE
  96 #  define MY_CXT_CLONE \
  97     dMY_CXT_SV;                                                      \
  98     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  99     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
 100     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
 101 # endif
 102 #else
 103 # define I_THREADSAFE 0
 104 # undef  dMY_CXT
 105 # define dMY_CXT      dNOOP
 106 # undef  MY_CXT
 107 # define MY_CXT       indirect_globaldata
 108 # undef  START_MY_CXT
 109 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
 110 # undef  MY_CXT_INIT
 111 # define MY_CXT_INIT  NOOP
 112 # undef  MY_CXT_CLONE
 113 # define MY_CXT_CLONE NOOP
 114 #endif
 115
 116 /* --- Helpers ------------------------------------------------------------- */
 117
 118 /* ... Pointer table ....................................................... */
 119
 120 #define PTABLE_NAME        ptable
 121 #define PTABLE_VAL_FREE(V) if ((V) && !SvIS_FREED((SV *) (V))) SvREFCNT_dec(V)
 122
 123 #define pPTBL  pTHX
 124 #define pPTBL_ pTHX_
 125 #define aPTBL  aTHX
 126 #define aPTBL_ aTHX_
 127
 128 #include "ptable.h"
 129
 130 #define ptable_store(T, K, V) ptable_store(aTHX_ (T), (K), (V))
 131 #define ptable_clear(T)       ptable_clear(aTHX_ (T))
 132 #define ptable_free(T)        ptable_free(aTHX_ (T))
 133
 134 /* ... Thread-safe hints ................................................... */
 135
 136 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 137
 138 #if I_THREADSAFE
 139
 140 typedef struct {
 141  ptable     *tbl;
 142  ptable     *map;
 143  tTHX        owner;
 144  const char *linestr;
 145 } my_cxt_t;
 146
 147 #else
 148
 149 typedef struct {
 150  ptable     *map;
 151  const char *linestr;
 152 } my_cxt_t;
 153
 154 #endif /* I_THREADSAFE */
 155
 156 START_MY_CXT
 157
 158 #if I_THREADSAFE
 159
 160 STATIC void indirect_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
 161  my_cxt_t *ud  = ud_;
 162  SV       *val = ent->val;
 163
 164  if (ud->owner != aTHX) {
 165   CLONE_PARAMS param;
 166   AV *stashes = (SvTYPE(val) == SVt_PVHV && HvNAME_get(val)) ? newAV() : NULL;
 167   param.stashes    = stashes;
 168   param.flags      = 0;
 169   param.proto_perl = ud->owner;
 170   val = sv_dup(val, &param);
 171   if (stashes) {
 172    av_undef(stashes);
 173    SvREFCNT_dec(stashes);
 174   }
 175  }
 176
 177  ptable_store(ud->tbl, ent->key, val);
 178  SvREFCNT_inc(val);
 179 }
 180
 181 STATIC void indirect_thread_cleanup(pTHX_ void *);
 182
 183 STATIC void indirect_thread_cleanup(pTHX_ void *ud) {
 184  int *level = ud;
 185  SV  *id;
 186
 187  if (*level) {
 188   *level = 0;
 189   LEAVE;
 190   SAVEDESTRUCTOR_X(indirect_thread_cleanup, level);
 191   ENTER;
 192  } else {
 193   dMY_CXT;
 194   PerlMemShared_free(level);
 195   ptable_free(MY_CXT.map);
 196   ptable_free(MY_CXT.tbl);
 197  }
 198 }
 199
 200 STATIC SV *indirect_tag(pTHX_ SV *value) {
 201 #define indirect_tag(V) indirect_tag(aTHX_ (V))
 202  dMY_CXT;
 203
 204  value = SvOK(value) && SvROK(value) ? SvRV(value) : NULL;
 205  /* We only need for the key to be an unique tag for looking up the value later.
 206   * Allocated memory provides convenient unique identifiers, so that's why we
 207   * use the value pointer as the key itself. */
 208  ptable_store(MY_CXT.tbl, value, value);
 209  SvREFCNT_inc(value);
 210
 211  return newSVuv(PTR2UV(value));
 212 }
 213
 214 STATIC SV *indirect_detag(pTHX_ const SV *hint) {
 215 #define indirect_detag(H) indirect_detag(aTHX_ (H))
 216  void *tag;
 217  SV   *value;
 218
 219  if (!hint || !SvOK(hint) || !SvIOK(hint))
 220   croak("Wrong hint");
 221
 222  tag = INT2PTR(void *, SvIVX(hint));
 223  {
 224   dMY_CXT;
 225   value = ptable_fetch(MY_CXT.tbl, tag);
 226  }
 227
 228  return value;
 229 }
 230
 231 #else
 232
 233 STATIC SV *indirect_tag(pTHX_ SV *value) {
 234 #define indirect_tag(V) indirect_tag(aTHX_ (V))
 235  UV tag = 0;
 236
 237  if (SvOK(value) && SvROK(value)) {
 238   value = SvRV(value);
 239   SvREFCNT_inc(value);
 240   tag = PTR2UV(value);
 241  }
 242
 243  return newSVuv(tag);
 244 }
 245
 246 #define indirect_detag(H) INT2PTR(SV *, SvUVX(H))
 247
 248 #endif /* I_THREADSAFE */
 249
 250 STATIC U32 indirect_hash = 0;
 251
 252 STATIC SV *indirect_hint(pTHX) {
 253 #define indirect_hint() indirect_hint(aTHX)
 254  SV *id;
 255 #if I_HAS_PERL(5, 10, 0)
 256  id = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
 257                                      NULL,
 258                                      __PACKAGE__, __PACKAGE_LEN__,
 259                                      0,
 260                                      indirect_hash);
 261 #else
 262  SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__,
 263                                                                  indirect_hash);
 264  if (!val)
 265   return 0;
 266  id = *val;
 267 #endif
 268  return (id && SvOK(id)) ? id : NULL;
 269 }
 270
 271 /* ... op -> source position ............................................... */
 272
 273 STATIC void indirect_map_store(pTHX_ const OP *o, const char *src, SV *sv) {
 274 #define indirect_map_store(O, S, N) indirect_map_store(aTHX_ (O), (S), (N))
 275  dMY_CXT;
 276  SV *val;
 277
 278  /* When lex_inwhat is set, we're in a quotelike environment (qq, qr, but not q)
 279   * In this case the linestr has temporarly changed, but the old buffer should
 280   * still be alive somewhere. */
 281
 282  if (!PL_lex_inwhat) {
 283   const char *pl_linestr = SvPVX_const(PL_linestr);
 284   if (MY_CXT.linestr != pl_linestr) {
 285    ptable_clear(MY_CXT.map);
 286    MY_CXT.linestr = pl_linestr;
 287   }
 288  }
 289
 290  val = newSVsv(sv);
 291  SvUPGRADE(val, SVt_PVIV);
 292  SvUVX(val) = PTR2UV(src);
 293  SvIOK_on(val);
 294  SvIsUV_on(val);
 295
 296  ptable_store(MY_CXT.map, o, val);
 297 }
 298
 299 STATIC const char *indirect_map_fetch(pTHX_ const OP *o, SV ** const name) {
 300 #define indirect_map_fetch(O, S) indirect_map_fetch(aTHX_ (O), (S))
 301  dMY_CXT;
 302  SV *val;
 303
 304  if (MY_CXT.linestr != SvPVX_const(PL_linestr))
 305   return NULL;
 306
 307  val = ptable_fetch(MY_CXT.map, o);
 308  if (!val) {
 309   *name = NULL;
 310   return NULL;
 311  }
 312
 313  *name = val;
 314  return INT2PTR(const char *, SvUVX(val));
 315 }
 316
 317 /* --- Check functions ----------------------------------------------------- */
 318
 319 STATIC const char *indirect_find(pTHX_ SV *sv, const char *s) {
 320 #define indirect_find(N, S) indirect_find(aTHX_ (N), (S))
 321  STRLEN len;
 322  const char *p = NULL, *r = SvPV_const(sv, len);
 323
 324  if (len >= 1 && *r == '$') {
 325   ++r;
 326   --len;
 327   s = strchr(s, '$');
 328   if (!s)
 329    return NULL;
 330  }
 331
 332  p = strstr(s, r);
 333  while (p) {
 334   p += len;
 335   if (!isALNUM(*p))
 336    break;
 337   p = strstr(p + 1, r);
 338  }
 339
 340  return p;
 341 }
 342
 343 /* ... ck_const ............................................................ */
 344
 345 STATIC OP *(*indirect_old_ck_const)(pTHX_ OP *) = 0;
 346
 347 STATIC OP *indirect_ck_const(pTHX_ OP *o) {
 348  o = CALL_FPTR(indirect_old_ck_const)(aTHX_ o);
 349
 350  if (indirect_hint()) {
 351   SV *sv = cSVOPo_sv;
 352   if (SvPOK(sv) && (SvTYPE(sv) >= SVt_PV))
 353    indirect_map_store(o, indirect_find(sv, PL_oldbufptr), sv);
 354  }
 355
 356  return o;
 357 }
 358
 359 /* ... ck_rv2sv ............................................................ */
 360
 361 STATIC OP *(*indirect_old_ck_rv2sv)(pTHX_ OP *) = 0;
 362
 363 STATIC OP *indirect_ck_rv2sv(pTHX_ OP *o) {
 364  if (indirect_hint()) {
 365   OP *op = cUNOPo->op_first;
 366   SV *sv;
 367   const char *name = NULL, *s;
 368   STRLEN len;
 369   OPCODE type = (OPCODE) op->op_type;
 370
 371   switch (type) {
 372    case OP_GV:
 373    case OP_GVSV: {
 374     GV *gv = cGVOPx_gv(op);
 375     name = GvNAME(gv);
 376     len  = GvNAMELEN(gv);
 377     break;
 378    }
 379    default:
 380     if ((PL_opargs[type] & OA_CLASS_MASK) == OA_SVOP) {
 381      SV *nsv = cSVOPx_sv(op);
 382      if (SvPOK(nsv) && (SvTYPE(nsv) >= SVt_PV))
 383       name = SvPV_const(nsv, len);
 384     }
 385   }
 386   if (!name)
 387    goto done;
 388
 389   sv = sv_2mortal(newSVpvn("$", 1));
 390   sv_catpvn_nomg(sv, name, len);
 391   s = indirect_find(sv, PL_oldbufptr);
 392   if (!s) { /* If it failed, retry without the current stash */
 393    const char *stash = HvNAME_get(PL_curstash);
 394    STRLEN stashlen = HvNAMELEN_get(PL_curstash);
 395
 396    if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
 397        || name[stashlen] != ':' || name[stashlen+1] != ':') {
 398     /* Failed again ? Try to remove main */
 399     stash = "main";
 400     stashlen = 4;
 401     if ((len < stashlen + 2) || strnNE(name, stash, stashlen)
 402         || name[stashlen] != ':' || name[stashlen+1] != ':')
 403      goto done;
 404    }
 405
 406    sv_setpvn(sv, "$", 1);
 407    stashlen += 2;
 408    sv_catpvn_nomg(sv, name + stashlen, len - stashlen);
 409    s = indirect_find(sv, PL_oldbufptr);
 410    if (!s)
 411     goto done;
 412   }
 413
 414   o = CALL_FPTR(indirect_old_ck_rv2sv)(aTHX_ o);
 415   indirect_map_store(o, s, sv);
 416   return o;
 417  }
 418
 419 done:
 420  return CALL_FPTR(indirect_old_ck_rv2sv)(aTHX_ o);
 421 }
 422
 423 /* ... ck_padany ........................................................... */
 424
 425 STATIC OP *(*indirect_old_ck_padany)(pTHX_ OP *) = 0;
 426
 427 STATIC OP *indirect_ck_padany(pTHX_ OP *o) {
 428  o = CALL_FPTR(indirect_old_ck_padany)(aTHX_ o);
 429
 430  if (indirect_hint()) {
 431   SV *sv;
 432   const char *s = PL_oldbufptr, *t = PL_bufptr - 1;
 433
 434   while (s < t && isSPACE(*s)) ++s;
 435   if (*s == '$' && ++s <= t) {
 436    while (s < t && isSPACE(*s)) ++s;
 437    while (s < t && isSPACE(*t)) --t;
 438    sv = sv_2mortal(newSVpvn("$", 1));
 439    sv_catpvn_nomg(sv, s, t - s + 1);
 440    indirect_map_store(o, s, sv);
 441   }
 442  }
 443
 444  return o;
 445 }
 446
 447 /* ... ck_method ........................................................... */
 448
 449 STATIC OP *(*indirect_old_ck_method)(pTHX_ OP *) = 0;
 450
 451 STATIC OP *indirect_ck_method(pTHX_ OP *o) {
 452  if (indirect_hint()) {
 453   OP *op = cUNOPo->op_first;
 454   SV *sv;
 455   const char *s = indirect_map_fetch(op, &sv);
 456   if (!s) {
 457    sv = cSVOPx_sv(op);
 458    if (!SvPOK(sv) || (SvTYPE(sv) < SVt_PV))
 459     goto done;
 460    sv = sv_mortalcopy(sv);
 461    s  = indirect_find(sv, PL_oldbufptr);
 462   }
 463   o = CALL_FPTR(indirect_old_ck_method)(aTHX_ o);
 464   /* o may now be a method_named */
 465   indirect_map_store(o, s, sv);
 466   return o;
 467  }
 468
 469 done:
 470  return CALL_FPTR(indirect_old_ck_method)(aTHX_ o);
 471 }
 472
 473 /* ... ck_entersub ......................................................... */
 474
 475 STATIC OP *(*indirect_old_ck_entersub)(pTHX_ OP *) = 0;
 476
 477 STATIC OP *indirect_ck_entersub(pTHX_ OP *o) {
 478  SV *hint = indirect_hint();
 479
 480  o = CALL_FPTR(indirect_old_ck_entersub)(aTHX_ o);
 481
 482  if (hint) {
 483   const char *mpos, *opos;
 484   SV *mnamesv, *onamesv;
 485   OP *mop, *oop;
 486   LISTOP *lop;
 487
 488   oop = o;
 489   do {
 490    lop = (LISTOP *) oop;
 491    if (!(lop->op_flags & OPf_KIDS))
 492     goto done;
 493    oop = lop->op_first;
 494   } while (oop->op_type != OP_PUSHMARK);
 495   oop = oop->op_sibling;
 496   mop = lop->op_last;
 497
 498   if (mop->op_type == OP_METHOD)
 499    mop = cUNOPx(mop)->op_first;
 500   else if (mop->op_type != OP_METHOD_NAMED)
 501    goto done;
 502
 503   mpos = indirect_map_fetch(mop, &mnamesv);
 504   if (!mpos)
 505    goto done;
 506
 507   opos = indirect_map_fetch(oop, &onamesv);
 508   if (!opos)
 509    goto done;
 510
 511   if (mpos < opos) {
 512    SV *code = indirect_detag(hint);
 513
 514    if (hint) {
 515     dSP;
 516
 517     ENTER;
 518     SAVETMPS;
 519
 520     PUSHMARK(SP);
 521     EXTEND(SP, 2);
 522     PUSHs(onamesv);
 523     PUSHs(mnamesv);
 524     PUTBACK;
 525
 526     call_sv(code, G_VOID);
 527
 528     PUTBACK;
 529
 530     FREETMPS;
 531     LEAVE;
 532    }
 533   }
 534  }
 535
 536 done:
 537  return o;
 538 }
 539
 540 STATIC U32 indirect_initialized = 0;
 541
 542 /* --- XS ------------------------------------------------------------------ */
 543
 544 MODULE = indirect      PACKAGE = indirect
 545
 546 PROTOTYPES: ENABLE
 547
 548 BOOT:
 549 {
 550  if (!indirect_initialized++) {
 551   HV *stash;
 552
 553   MY_CXT_INIT;
 554   MY_CXT.map     = ptable_new();
 555   MY_CXT.linestr = NULL;
 556 #if I_THREADSAFE
 557   MY_CXT.tbl     = ptable_new();
 558   MY_CXT.owner   = aTHX;
 559 #endif
 560
 561   PERL_HASH(indirect_hash, __PACKAGE__, __PACKAGE_LEN__);
 562
 563   indirect_old_ck_const    = PL_check[OP_CONST];
 564   PL_check[OP_CONST]       = MEMBER_TO_FPTR(indirect_ck_const);
 565   indirect_old_ck_rv2sv    = PL_check[OP_RV2SV];
 566   PL_check[OP_RV2SV]       = MEMBER_TO_FPTR(indirect_ck_rv2sv);
 567   indirect_old_ck_padany   = PL_check[OP_PADANY];
 568   PL_check[OP_PADANY]      = MEMBER_TO_FPTR(indirect_ck_padany);
 569   indirect_old_ck_method   = PL_check[OP_METHOD];
 570   PL_check[OP_METHOD]      = MEMBER_TO_FPTR(indirect_ck_method);
 571   indirect_old_ck_entersub = PL_check[OP_ENTERSUB];
 572   PL_check[OP_ENTERSUB]    = MEMBER_TO_FPTR(indirect_ck_entersub);
 573
 574   stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
 575   newCONSTSUB(stash, "I_THREADSAFE", newSVuv(I_THREADSAFE));
 576  }
 577 }
 578
 579 #if I_THREADSAFE
 580
 581 void
 582 CLONE(...)
 583 PROTOTYPE: DISABLE
 584 PREINIT:
 585  ptable *t;
 586  int    *level;
 587 CODE:
 588  {
 589   my_cxt_t ud;
 590   dMY_CXT;
 591   ud.tbl   = t = ptable_new();
 592   ud.owner = MY_CXT.owner;
 593   ptable_walk(MY_CXT.tbl, indirect_ptable_clone, &ud);
 594  }
 595  {
 596   MY_CXT_CLONE;
 597   MY_CXT.map     = ptable_new();
 598   MY_CXT.linestr = NULL;
 599   MY_CXT.tbl     = t;
 600   MY_CXT.owner   = aTHX;
 601  }
 602  {
 603   level = PerlMemShared_malloc(sizeof *level);
 604   *level = 1;
 605   LEAVE;
 606   SAVEDESTRUCTOR_X(indirect_thread_cleanup, level);
 607   ENTER;
 608  }
 609
 610 #endif
 611
 612 SV *
 613 _tag(SV *value)
 614 PROTOTYPE: $
 615 CODE:
 616  RETVAL = indirect_tag(value);
 617 OUTPUT:
 618  RETVAL