Hooks.xs

   1 /* This file is part of the re::engine::Hooks Perl module.
   2  * See http://search.cpan.org/dist/re-engine-Hooks/ */
   3
   4 #define PERL_NO_GET_CONTEXT
   5 #include "EXTERN.h"
   6 #include "perl.h"
   7 #include "XSUB.h"
   8
   9 #define __PACKAGE__     "re::engine::Hooks"
  10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
  11
  12 /* --- Compatibility wrappers ---------------------------------------------- */
  13
  14 #define REH_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  15
  16 #ifndef SvPV_const
  17 # define SvPV_const(S, L) SvPV(S, L)
  18 #endif
  19
  20 /* ... Thread safety and multiplicity ...................................... */
  21
  22 #ifndef REH_MULTIPLICITY
  23 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  24 #  define REH_MULTIPLICITY 1
  25 # else
  26 #  define REH_MULTIPLICITY 0
  27 # endif
  28 #endif
  29
  30 #ifdef USE_ITHREADS
  31 # define REH_LOCK(M)   MUTEX_LOCK(M)
  32 # define REH_UNLOCK(M) MUTEX_UNLOCK(M)
  33 #else
  34 # define REH_LOCK(M)   NOOP
  35 # define REH_UNLOCK(M) NOOP
  36 #endif
  37
  38 /* --- Lexical hints ------------------------------------------------------- */
  39
  40 STATIC U32 reh_hash = 0;
  41
  42 STATIC SV *reh_hint(pTHX) {
  43 #define reh_hint() reh_hint(aTHX)
  44  SV *hint;
  45
  46 #ifdef cop_hints_fetch_pvn
  47  hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__,
  48                                        reh_hash, 0);
  49 #elif REH_HAS_PERL(5, 9, 5)
  50  hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
  51                                        NULL,
  52                                        __PACKAGE__, __PACKAGE_LEN__,
  53                                        0,
  54                                        reh_hash);
  55 #else
  56  SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
  57  if (!val)
  58   return 0;
  59  hint = *val;
  60 #endif
  61
  62  return hint;
  63 }
  64
  65 /* --- Public API ---------------------------------------------------------- */
  66
  67 #include "re_engine_hooks.h"
  68
  69 typedef struct reh_action {
  70  struct reh_action *next;
  71  reh_config         cbs;
  72  const char        *key;
  73  STRLEN             klen;
  74 } reh_action;
  75
  76 STATIC reh_action *reh_action_list = 0;
  77
  78 #ifdef USE_ITHREADS
  79
  80 STATIC perl_mutex reh_action_list_mutex;
  81
  82 #endif /* USE_ITHREADS */
  83
  84 #undef reh_register
  85 void reh_register(pTHX_ const char *key, reh_config *cfg) {
  86  reh_action *a;
  87  char       *key_dup;
  88  STRLEN      i, len;
  89
  90  len = strlen(key);
  91  for (i = 0; i < len; ++i)
  92   if (!isALNUM(key[i]) && key[i] != ':')
  93    croak("Invalid key");
  94  key_dup = PerlMemShared_malloc(len + 1);
  95  memcpy(key_dup, key, len);
  96  key_dup[len] = '\0';
  97
  98  a       = PerlMemShared_malloc(sizeof *a);
  99  a->cbs  = *cfg;
 100  a->key  = key_dup;
 101  a->klen = len;
 102
 103  REH_LOCK(&reh_action_list_mutex);
 104  a->next         = reh_action_list;
 105  reh_action_list = a;
 106  REH_UNLOCK(&reh_action_list_mutex);
 107
 108  return;
 109 }
 110
 111 /* --- Custom regexp engine ------------------------------------------------ */
 112
 113 #if PERL_VERSION <= 10
 114 # define rxREGEXP(RX)  (RX)
 115 #else
 116 # define rxREGEXP(RX)  (SvANY(RX))
 117 #endif
 118
 119 #if PERL_VERSION <= 10
 120 EXTERN_C REGEXP *reh_re_compile(pTHX_ const SV * const, const U32);
 121 #else
 122 EXTERN_C REGEXP *reh_re_compile(pTHX_ SV * const, U32);
 123 #endif
 124 EXTERN_C I32     reh_regexec_flags(pTHX_ REGEXP * const, char *, char *, char *, I32, SV *, void *, U32);
 125 EXTERN_C char *  reh_re_intuit_start(pTHX_ REGEXP * const, SV *, char *, char *, U32, re_scream_pos_data *);
 126 EXTERN_C SV *    reh_re_intuit_string(pTHX_ REGEXP * const);
 127 EXTERN_C void    reh_re_free(pTHX_ REGEXP * const);
 128 EXTERN_C void    reh_reg_numbered_buff_fetch(pTHX_ REGEXP * const,
 129                                                    const I32, SV * const);
 130 EXTERN_C void    reh_reg_numbered_buff_store(pTHX_ REGEXP * const,
 131                                                    const I32, SV const * const);
 132 EXTERN_C I32     reh_reg_numbered_buff_length(pTHX_ REGEXP * const,
 133                                                    const SV * const, const I32);
 134 EXTERN_C SV *    reh_reg_named_buff(pTHX_ REGEXP * const, SV * const,
 135                                           SV * const, const U32);
 136 EXTERN_C SV *    reh_reg_named_buff_iter(pTHX_ REGEXP * const,
 137                                                const SV * const, const U32);
 138 EXTERN_C SV *    reh_reg_qr_package(pTHX_ REGEXP * const);
 139 #ifdef USE_ITHREADS
 140 EXTERN_C void *  reh_re_dupe(pTHX_ REGEXP * const, CLONE_PARAMS *);
 141 #endif
 142 #if REH_HAS_PERL(5, 17, 1)
 143 EXTERN_C REGEXP *reh_re_op_compile(pTHX_ SV ** const, int, OP *, const regexp_engine*, REGEXP *VOL, bool *, U32, U32);
 144 #endif
 145
 146 const struct regexp_engine reh_regexp_engine = {
 147  reh_re_compile,
 148  reh_regexec_flags,
 149  reh_re_intuit_start,
 150  reh_re_intuit_string,
 151  reh_re_free,
 152  reh_reg_numbered_buff_fetch,
 153  reh_reg_numbered_buff_store,
 154  reh_reg_numbered_buff_length,
 155  reh_reg_named_buff,
 156  reh_reg_named_buff_iter,
 157  reh_reg_qr_package
 158 #if defined(USE_ITHREADS)
 159  , reh_re_dupe
 160 #endif
 161 #if REH_HAS_PERL(5, 17, 1)
 162  , reh_re_op_compile
 163 #endif
 164 };
 165
 166 /* --- Internal regexp structure -> hook list inside-out mapping ----------- */
 167
 168 typedef struct {
 169  size_t            count;
 170  const reh_config *cbs;
 171  U32               refcount;
 172 } reh_private;
 173
 174 STATIC void reh_private_free(pTHX_ reh_private *priv) {
 175 #define reh_private_free(P) reh_private_free(aTHX_ (P))
 176  if (priv->refcount <= 1) {
 177   PerlMemShared_free((void *) priv->cbs);
 178   PerlMemShared_free(priv);
 179  } else {
 180   --priv->refcount;
 181  }
 182 }
 183
 184 #define PTABLE_NAME        ptable_private
 185 #define PTABLE_VAL_FREE(V) reh_private_free(V)
 186
 187 #define pPTBL  pTHX
 188 #define pPTBL_ pTHX_
 189 #define aPTBL  aTHX
 190 #define aPTBL_ aTHX_
 191
 192 #include "ptable.h"
 193
 194 #define ptable_private_store(T, K, V) ptable_private_store(aTHX_ (T), (K), (V))
 195 #define ptable_private_delete(T, K)   ptable_private_delete(aTHX_ (T), (K))
 196 #define ptable_private_clear(T)       ptable_private_clear(aTHX_ (T))
 197 #define ptable_private_free(T)        ptable_private_free(aTHX_ (T))
 198
 199 STATIC ptable *reh_private_map;
 200
 201 #ifdef USE_ITHREADS
 202
 203 STATIC perl_mutex reh_private_map_mutex;
 204
 205 #endif /* USE_ITHREADS */
 206
 207 #define REH_PRIVATE_MAP_FOREACH(C) STMT_START {      \
 208  reh_private *priv;                                  \
 209  REH_LOCK(&reh_private_map_mutex);                   \
 210  priv = ptable_fetch(reh_private_map, rx->pprivate); \
 211  if (priv) {                                         \
 212   const reh_config *cbs = priv->cbs;                 \
 213   if (cbs) {                                         \
 214    const reh_config *end = cbs + priv->count;        \
 215    for (; cbs < end; ++cbs) {                        \
 216     (C);                                             \
 217    }                                                 \
 218   }                                                  \
 219  }                                                   \
 220  REH_UNLOCK(&reh_private_map_mutex);                 \
 221 } STMT_END
 222
 223 STATIC void reh_private_map_store(pTHX_ void *ri, reh_private *priv) {
 224 #define reh_private_map_store(R, P) reh_private_map_store(aTHX_ (R), (P))
 225  REH_LOCK(&reh_private_map_mutex);
 226  ptable_private_store(reh_private_map, ri, priv);
 227  REH_UNLOCK(&reh_private_map_mutex);
 228
 229  return;
 230 }
 231
 232 STATIC void reh_private_map_copy(pTHX_ void *ri_from, void *ri_to) {
 233 #define reh_private_map_copy(F, T) reh_private_map_copy(aTHX_ (F), (T))
 234  reh_private *priv;
 235
 236  REH_LOCK(&reh_private_map_mutex);
 237  priv = ptable_fetch(reh_private_map, ri_from);
 238  if (priv) {
 239   ++priv->refcount;
 240   ptable_private_store(reh_private_map, ri_to, priv);
 241  }
 242  REH_UNLOCK(&reh_private_map_mutex);
 243 }
 244
 245 STATIC void reh_private_map_delete(pTHX_ void *ri) {
 246 #define reh_private_map_delete(R) reh_private_map_delete(aTHX_ (R))
 247  REH_LOCK(&reh_private_map_mutex);
 248  ptable_private_delete(reh_private_map, ri);
 249  REH_UNLOCK(&reh_private_map_mutex);
 250
 251  return;
 252 }
 253
 254 /* --- Private API --------------------------------------------------------- */
 255
 256 void reh_call_comp_begin_hook(pTHX_ regexp *rx) {
 257  SV *hint = reh_hint();
 258
 259  if (hint && SvPOK(hint)) {
 260   STRLEN      len;
 261   const char *keys  = SvPV_const(hint, len);
 262   size_t      count = 0;
 263
 264   reh_private *priv;
 265   reh_config  *cbs = NULL;
 266   reh_action  *a, *root;
 267
 268   REH_LOCK(&reh_action_list_mutex);
 269   root = reh_action_list;
 270   REH_UNLOCK(&reh_action_list_mutex);
 271
 272   for (a = root; a; a = a->next) {
 273    char *p = strstr(keys, a->key);
 274
 275    if (p && (p + a->klen <= keys + len) && p[a->klen] == ' ')
 276     ++count;
 277   }
 278
 279   if (count) {
 280    size_t i = 0;
 281
 282    cbs = PerlMemShared_malloc(count * sizeof *cbs);
 283
 284    for (a = root; a; a = a->next) {
 285     char *p = strstr(keys, a->key);
 286
 287     if (p && (p + a->klen <= keys + len) && p[a->klen] == ' ')
 288      cbs[i++] = a->cbs;
 289    }
 290   }
 291
 292   priv = PerlMemShared_malloc(sizeof *priv);
 293   priv->count    = count;
 294   priv->cbs      = cbs;
 295   priv->refcount = 1;
 296
 297   rx->engine = &reh_regexp_engine;
 298
 299   reh_private_map_store(rx->pprivate, priv);
 300  }
 301 }
 302
 303 void reh_call_comp_node_hook(pTHX_ regexp *rx, regnode *node) {
 304  REH_PRIVATE_MAP_FOREACH(cbs->comp_node(aTHX_ rx, node));
 305 }
 306
 307 void reh_call_exec_node_hook(pTHX_ regexp *rx, regnode *node, regmatch_info *reginfo, regmatch_state *st) {
 308  REH_PRIVATE_MAP_FOREACH(cbs->exec_node(aTHX_ rx, node, reginfo, st));
 309 }
 310
 311 EXTERN_C void reh_regfree_internal(pTHX_ REGEXP * const);
 312
 313 void reh_re_free(pTHX_ REGEXP * const RX) {
 314  regexp *rx = rxREGEXP(RX);
 315
 316  reh_private_map_delete(rx->pprivate);
 317
 318  reh_regfree_internal(aTHX_ RX);
 319 }
 320
 321 #ifdef USE_ITHREADS
 322
 323 EXTERN_C void *reh_regdupe_internal(pTHX_ REGEXP * const, CLONE_PARAMS *);
 324
 325 void *reh_re_dupe(pTHX_ REGEXP * const RX, CLONE_PARAMS *param) {
 326  regexp *rx = rxREGEXP(RX);
 327  void   *new_ri;
 328
 329  new_ri = reh_regdupe_internal(aTHX_ RX, param);
 330
 331  reh_private_map_copy(rx->pprivate, new_ri);
 332
 333  return new_ri;
 334 }
 335
 336 #endif
 337
 338 STATIC void reh_teardown(pTHX_ void *root) {
 339 #if REH_MULTIPLICITY
 340  if (aTHX != root)
 341   return;
 342 #endif
 343
 344  ptable_private_free(reh_private_map);
 345 }
 346
 347 /* --- XS ------------------------------------------------------------------ */
 348
 349 MODULE = re::engine::Hooks          PACKAGE = re::engine::Hooks
 350
 351 PROTOTYPES: ENABLE
 352
 353 BOOT:
 354 {
 355  reh_private_map = ptable_new();
 356 #ifdef USE_ITHREADS
 357  MUTEX_INIT(&reh_action_list_mutex);
 358  MUTEX_INIT(&reh_private_map_mutex);
 359 #endif
 360  PERL_HASH(reh_hash, __PACKAGE__, __PACKAGE_LEN__);
 361 #if REH_MULTIPLICITY
 362  call_atexit(reh_teardown, aTHX);
 363 #else
 364  call_atexit(reh_teardown, NULL);
 365 #endif
 366 }
 367
 368 void
 369 _ENGINE()
 370 PROTOTYPE:
 371 PPCODE:
 372  XPUSHs(sv_2mortal(newSViv(PTR2IV(&reh_regexp_engine))));
 373
 374 void
 375 _registered(SV *key)
 376 PROTOTYPE: $
 377 PREINIT:
 378  SV         *ret = NULL;
 379  reh_action *a;
 380  STRLEN      len;
 381  const char *s;
 382 PPCODE:
 383  REH_LOCK(&reh_action_list_mutex);
 384  a = reh_action_list;
 385  REH_UNLOCK(&reh_action_list_mutex);
 386  s = SvPV_const(key, len);
 387  while (a && !ret) {
 388   if (a->klen == len && memcmp(a->key, s, len) == 0)
 389    ret = &PL_sv_yes;
 390   a = a->next;
 391  }
 392  if (!ret)
 393   ret = &PL_sv_no;
 394  EXTEND(SP, 1);
 395  PUSHs(ret);
 396  XSRETURN(1);