autovivification.xs

   1 /* This file is part of the autovivification Perl module.
   2  * See http://search.cpan.org/dist/autovivification/ */
   3
   4 #define PERL_NO_GET_CONTEXT
   5 #include "EXTERN.h"
   6 #include "perl.h"
   7 #include "XSUB.h"
   8
   9 #define __PACKAGE__     "autovivification"
  10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
  11
  12 /* --- Compatibility wrappers ---------------------------------------------- */
  13
  14 #define A_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  15
  16 #ifndef A_WORKAROUND_REQUIRE_PROPAGATION
  17 # define A_WORKAROUND_REQUIRE_PROPAGATION !A_HAS_PERL(5, 10, 1)
  18 #endif
  19
  20 /* --- Helpers ------------------------------------------------------------- */
  21
  22 #if A_WORKAROUND_REQUIRE_PROPAGATION
  23
  24 typedef struct {
  25  UV  bits;
  26  I32 requires;
  27 } a_hint_t;
  28
  29 STATIC SV *a_tag(pTHX_ UV bits) {
  30 #define a_tag(B) a_tag(aTHX_ (B))
  31  SV *tag;
  32  a_hint_t h;
  33
  34  h.bits = bits;
  35
  36  {
  37   const PERL_SI *si;
  38   I32            requires = 0;
  39
  40   for (si = PL_curstackinfo; si; si = si->si_prev) {
  41    I32 cxix;
  42
  43    for (cxix = si->si_cxix; cxix >= 0; --cxix) {
  44     const PERL_CONTEXT *cx = si->si_cxstack + cxix;
  45
  46     if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE)
  47      ++requires;
  48    }
  49   }
  50
  51   h.requires = requires;
  52  }
  53
  54  return newSVpvn((const char *) &h, sizeof h);
  55 }
  56
  57 STATIC UV a_detag(pTHX_ const SV *hint) {
  58 #define a_detag(H) a_detag(aTHX_ (H))
  59  const a_hint_t *h;
  60
  61  if (!(hint && SvOK(hint)))
  62   return 0;
  63
  64  h = (const a_hint_t *) SvPVX(hint);
  65
  66  {
  67   const PERL_SI *si;
  68   I32            requires = 0;
  69
  70   for (si = PL_curstackinfo; si; si = si->si_prev) {
  71    I32 cxix;
  72
  73    for (cxix = si->si_cxix; cxix >= 0; --cxix) {
  74     const PERL_CONTEXT *cx = si->si_cxstack + cxix;
  75
  76     if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE
  77                                && ++requires > h->requires)
  78      return 0;
  79    }
  80   }
  81  }
  82
  83  return h->bits;
  84 }
  85
  86 #else /* A_WORKAROUND_REQUIRE_PROPAGATION */
  87
  88 #define a_tag(B)   newSVuv(B)
  89 #define a_detag(H) (((H) && SvOK(H)) ? SvUVX(H) : 0)
  90
  91 #endif /* !A_WORKAROUND_REQUIRE_PROPAGATION */
  92
  93 /* Used both for hints and op flags */
  94 #define A_HINT_STRICT 1
  95 #define A_HINT_WARN   2
  96 #define A_HINT_FETCH  4
  97 #define A_HINT_STORE  8
  98 #define A_HINT_EXISTS 16
  99 #define A_HINT_DELETE 32
 100 #define A_HINT_NOTIFY (A_HINT_STRICT|A_HINT_WARN)
 101 #define A_HINT_DO     (A_HINT_FETCH|A_HINT_STORE|A_HINT_EXISTS|A_HINT_DELETE)
 102 #define A_HINT_MASK   (A_HINT_NOTIFY|A_HINT_DO)
 103
 104 /* Only used in op flags */
 105 #define A_HINT_DEREF  64
 106
 107 STATIC U32 a_hash = 0;
 108
 109 STATIC UV a_hint(pTHX) {
 110 #define a_hint() a_hint(aTHX)
 111  const SV *hint;
 112 #if A_HAS_PERL(5, 9, 5)
 113  hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
 114                                        NULL,
 115                                        __PACKAGE__, __PACKAGE_LEN__,
 116                                        0,
 117                                        a_hash);
 118 #else
 119  SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, a_hash);
 120  if (!val)
 121   return 0;
 122  hint = *val;
 123 #endif
 124  return a_detag(hint);
 125 }
 126
 127 /* ... op => info map ...................................................... */
 128
 129 typedef struct {
 130  OP *(*old_pp)(pTHX);
 131  const OP *root;
 132  UV flags;
 133 } a_op_info;
 134
 135 #define PTABLE_NAME        ptable_map
 136 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
 137
 138 #include "ptable.h"
 139
 140 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
 141 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
 142
 143 STATIC ptable *a_op_map = NULL;
 144
 145 #ifdef USE_ITHREADS
 146 STATIC perl_mutex a_op_map_mutex;
 147 #endif
 148
 149 STATIC void a_map_store(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), UV flags) {
 150 #define a_map_store(O, PP, F) a_map_store(aPTBLMS_ (O), (PP), (F))
 151  a_op_info *oi;
 152
 153 #ifdef USE_ITHREADS
 154  MUTEX_LOCK(&a_op_map_mutex);
 155 #endif
 156
 157  if (!(oi = ptable_fetch(a_op_map, o))) {
 158   oi = PerlMemShared_malloc(sizeof *oi);
 159   ptable_map_store(a_op_map, o, oi);
 160  }
 161
 162  oi->old_pp = old_pp;
 163  oi->root   = NULL;
 164  oi->flags  = flags;
 165
 166 #ifdef USE_ITHREADS
 167  MUTEX_UNLOCK(&a_op_map_mutex);
 168 #endif
 169 }
 170
 171 STATIC const a_op_info *a_map_fetch(const OP *o, a_op_info *oi) {
 172  const a_op_info *val;
 173
 174 #ifdef USE_ITHREADS
 175  MUTEX_LOCK(&a_op_map_mutex);
 176 #endif
 177
 178  val = ptable_fetch(a_op_map, o);
 179  if (val) {
 180   *oi = *val;
 181   val = oi;
 182  } else
 183   oi->old_pp = 0;
 184
 185 #ifdef USE_ITHREADS
 186  MUTEX_UNLOCK(&a_op_map_mutex);
 187 #endif
 188
 189  return val;
 190 }
 191
 192 STATIC void a_map_delete(pTHX_ const OP *o) {
 193 #define a_map_delete(O) a_map_delete(aTHX_ (O))
 194 #ifdef USE_ITHREADS
 195  MUTEX_LOCK(&a_op_map_mutex);
 196 #endif
 197
 198  ptable_map_store(a_op_map, o, NULL);
 199
 200 #ifdef USE_ITHREADS
 201  MUTEX_UNLOCK(&a_op_map_mutex);
 202 #endif
 203 }
 204
 205 STATIC void a_map_set_root(const OP *root, UV flags) {
 206  a_op_info *oi;
 207  const OP *o = root;
 208
 209 #ifdef USE_ITHREADS
 210  MUTEX_LOCK(&a_op_map_mutex);
 211 #endif
 212
 213  while (o) {
 214   if (oi = ptable_fetch(a_op_map, o)) {
 215    oi->root  = root;
 216    oi->flags = flags;
 217   }
 218   if (!(o->op_flags & OPf_KIDS))
 219    break;
 220   o = cUNOPo->op_first;
 221  }
 222
 223 #ifdef USE_ITHREADS
 224  MUTEX_UNLOCK(&a_op_map_mutex);
 225 #endif
 226 }
 227
 228 /* ... Lightweight pp_defined() ............................................ */
 229
 230 STATIC bool a_defined(pTHX_ SV *sv) {
 231 #define a_defined(S) a_defined(aTHX_ (S))
 232  bool defined = FALSE;
 233
 234  switch (SvTYPE(sv)) {
 235   case SVt_PVAV:
 236    if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
 237                       || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 238     defined = TRUE;
 239    break;
 240   case SVt_PVHV:
 241    if (HvARRAY(sv) || SvGMAGICAL(sv)
 242                    || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 243     defined = TRUE;
 244    break;
 245   default:
 246    defined = SvOK(sv);
 247  }
 248
 249  return defined;
 250 }
 251
 252 /* --- PP functions -------------------------------------------------------- */
 253
 254 /* ... pp_rv2av ............................................................ */
 255
 256 STATIC OP *a_pp_rv2av(pTHX) {
 257  a_op_info oi;
 258  UV hint;
 259  dSP;
 260
 261  if (!SvOK(TOPs)) {
 262   SV *av;
 263   POPs;
 264   av = sv_2mortal((SV *) newAV());
 265   PUSHs(av);
 266   RETURN;
 267  }
 268
 269  a_map_fetch(PL_op, &oi);
 270
 271  return CALL_FPTR(oi.old_pp)(aTHX);
 272 }
 273
 274 /* ... pp_rv2hv ............................................................ */
 275
 276 STATIC OP *a_pp_rv2hv(pTHX) {
 277  a_op_info oi;
 278  UV hint;
 279  dSP;
 280
 281  if (!SvOK(TOPs))
 282   RETURN;
 283
 284  a_map_fetch(PL_op, &oi);
 285
 286  return CALL_FPTR(oi.old_pp)(aTHX);
 287 }
 288
 289 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
 290
 291 STATIC const char a_msg_forbidden[]  = "Reference vivification forbidden";
 292 STATIC const char a_msg_impossible[] = "Can't vivify reference";
 293
 294 STATIC OP *a_pp_deref(pTHX) {
 295  a_op_info oi;
 296  UV flags;
 297  dSP;
 298
 299  a_map_fetch(PL_op, &oi);
 300  flags = oi.flags;
 301
 302  if (flags & A_HINT_DEREF) {
 303   OP *o;
 304   U8 old_private;
 305
 306 deref:
 307   old_private = PL_op->op_private;
 308   PL_op->op_private &= ~OPpDEREF;
 309   PL_op->op_private |= OPpLVAL_DEFER;
 310   o = CALL_FPTR(oi.old_pp)(aTHX);
 311   PL_op->op_private = old_private;
 312
 313   if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
 314    SPAGAIN;
 315    if (!SvOK(TOPs)) {
 316     if (flags & A_HINT_STRICT)
 317      croak(a_msg_forbidden);
 318     else if (flags & A_HINT_WARN)
 319       warn(a_msg_forbidden);
 320     else /* A_HINT_STORE */
 321      croak(a_msg_impossible);
 322    }
 323   }
 324
 325   return o;
 326  } else if (flags && (PL_op->op_private & OPpDEREF || PL_op == oi.root)) {
 327   oi.flags = flags & A_HINT_NOTIFY;
 328
 329   if (oi.root->op_flags & OPf_MOD) {
 330    if (flags & A_HINT_STORE)
 331     oi.flags |= (A_HINT_STORE|A_HINT_DEREF);
 332   } else if (flags & A_HINT_FETCH)
 333    oi.flags |= (A_HINT_FETCH|A_HINT_DEREF);
 334
 335   if (PL_op == oi.root)
 336    oi.flags &= ~A_HINT_DEREF;
 337
 338   /* We will need the updated flags value in the deref part */
 339   flags = oi.flags;
 340
 341   if (flags & A_HINT_DEREF)
 342    goto deref;
 343
 344   /* This op doesn't need to skip autovivification, so restore the original
 345    * state. Be aware that another extension might have saved a_pp_deref as the
 346    * ppaddr for this op, so restoring PL_op->op_ppaddr doesn't ensure that this
 347    * function will never be called again. That's why we don't remove the op info
 348    * from our map and we reset oi.flags to 0, so that it can still run correctly
 349    * if required. */
 350   oi.flags = 0;
 351   PL_op->op_ppaddr = oi.old_pp;
 352  }
 353
 354  return CALL_FPTR(oi.old_pp)(aTHX);
 355 }
 356
 357 /* ... pp_root (exists,delete) ............................................. */
 358
 359 STATIC OP *a_pp_root(pTHX) {
 360  a_op_info oi;
 361  dSP;
 362
 363  if (!a_defined(TOPm1s)) {
 364   POPs;
 365   POPs;
 366   if (PL_op->op_type == OP_EXISTS)
 367    RETPUSHNO;
 368   else
 369    RETPUSHUNDEF;
 370  }
 371
 372  a_map_fetch(PL_op, &oi);
 373
 374  return CALL_FPTR(oi.old_pp)(aTHX);
 375 }
 376
 377 /* --- Check functions ----------------------------------------------------- */
 378
 379 /* ... ck_pad{any,sv} ...................................................... */
 380
 381 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
 382  * function, but are instead manually mutated from a PADANY. This is why we set
 383  * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
 384  * their op_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
 385  * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
 386  * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
 387  * globally. */
 388
 389 STATIC OP *(*a_pp_padsv_saved)(pTHX) = 0;
 390
 391 STATIC void a_pp_padsv_save(void) {
 392  if (a_pp_padsv_saved)
 393   return;
 394
 395  a_pp_padsv_saved    = PL_ppaddr[OP_PADSV];
 396  PL_ppaddr[OP_PADSV] = a_pp_deref;
 397 }
 398
 399 STATIC void a_pp_padsv_restore(OP *o) {
 400  if (!a_pp_padsv_saved)
 401   return;
 402
 403  if (o->op_ppaddr == a_pp_deref)
 404   o->op_ppaddr = a_pp_padsv_saved;
 405
 406  PL_ppaddr[OP_PADSV] = a_pp_padsv_saved;
 407  a_pp_padsv_saved    = 0;
 408 }
 409
 410 STATIC OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
 411
 412 STATIC OP *a_ck_padany(pTHX_ OP *o) {
 413  UV hint;
 414
 415  a_pp_padsv_restore(o);
 416
 417  o = CALL_FPTR(a_old_ck_padany)(aTHX_ o);
 418
 419  hint = a_hint();
 420  if (hint & A_HINT_DO) {
 421   a_pp_padsv_save();
 422   a_map_store(o, a_pp_padsv_saved, hint);
 423  } else
 424   a_map_delete(o);
 425
 426  return o;
 427 }
 428
 429 STATIC OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
 430
 431 STATIC OP *a_ck_padsv(pTHX_ OP *o) {
 432  UV hint;
 433
 434  a_pp_padsv_restore(o);
 435
 436  o = CALL_FPTR(a_old_ck_padsv)(aTHX_ o);
 437
 438  hint = a_hint();
 439  if (hint & A_HINT_DO) {
 440   a_map_store(o, o->op_ppaddr, hint);
 441   o->op_ppaddr = a_pp_deref;
 442  } else
 443   a_map_delete(o);
 444
 445  return o;
 446 }
 447
 448 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
 449
 450 STATIC OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
 451 STATIC OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
 452 STATIC OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
 453
 454 STATIC OP *a_ck_deref(pTHX_ OP *o) {
 455  OP * (*old_ck)(pTHX_ OP *o) = 0;
 456  UV hint;
 457
 458  switch (o->op_type) {
 459   case OP_AELEM: old_ck = a_old_ck_aelem; break;
 460   case OP_HELEM: old_ck = a_old_ck_helem; break;
 461   case OP_RV2SV: old_ck = a_old_ck_rv2sv; break;
 462  }
 463  o = CALL_FPTR(old_ck)(aTHX_ o);
 464
 465  hint = a_hint();
 466  if (hint & A_HINT_DO) {
 467   if (!(hint & A_HINT_STRICT) && o->op_flags & OPf_KIDS) {
 468    OP *kid = cUNOPo->op_first;
 469    switch (kid->op_type) {
 470     case OP_RV2AV:
 471      a_map_store(kid, kid->op_ppaddr, hint);
 472      kid->op_ppaddr = a_pp_rv2av;
 473      break;
 474     case OP_RV2HV:
 475      a_map_store(kid, kid->op_ppaddr, hint);
 476      kid->op_ppaddr = a_pp_rv2hv;
 477      break;
 478    }
 479   }
 480   a_map_store(o, o->op_ppaddr, hint);
 481   o->op_ppaddr = a_pp_deref;
 482   a_map_set_root(o, hint);
 483  } else
 484   a_map_delete(o);
 485
 486  return o;
 487 }
 488
 489 /* ... ck_root (exists,delete) ............................................. */
 490
 491 STATIC OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
 492 STATIC OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
 493
 494 STATIC OP *a_ck_root(pTHX_ OP *o) {
 495  OP * (*old_ck)(pTHX_ OP *o) = 0;
 496  bool enabled = FALSE;
 497  UV hint = a_hint();
 498
 499  switch (o->op_type) {
 500   case OP_EXISTS:
 501    old_ck  = a_old_ck_exists;
 502    enabled = hint & A_HINT_EXISTS;
 503    break;
 504   case OP_DELETE:
 505    old_ck  = a_old_ck_delete;
 506    enabled = hint & A_HINT_DELETE;
 507    break;
 508  }
 509  o = CALL_FPTR(old_ck)(aTHX_ o);
 510
 511  if (enabled) {
 512   a_map_set_root(o, hint | A_HINT_DEREF);
 513   a_map_store(o, o->op_ppaddr, hint);
 514   o->op_ppaddr = a_pp_root;
 515  } else {
 516   a_map_set_root(o, 0);
 517  }
 518
 519  return o;
 520 }
 521
 522 STATIC U32 a_initialized = 0;
 523
 524 /* --- XS ------------------------------------------------------------------ */
 525
 526 MODULE = autovivification      PACKAGE = autovivification
 527
 528 PROTOTYPES: ENABLE
 529
 530 BOOT:
 531 {
 532  if (!a_initialized++) {
 533   HV *stash;
 534
 535   a_op_map = ptable_new();
 536 #ifdef USE_ITHREADS
 537   MUTEX_INIT(&a_op_map_mutex);
 538 #endif
 539
 540   PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
 541
 542   a_old_ck_padany     = PL_check[OP_PADANY];
 543   PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_ck_padany);
 544   a_old_ck_padsv      = PL_check[OP_PADSV];
 545   PL_check[OP_PADSV]  = MEMBER_TO_FPTR(a_ck_padsv);
 546   a_old_ck_aelem      = PL_check[OP_AELEM];
 547   PL_check[OP_AELEM]  = MEMBER_TO_FPTR(a_ck_deref);
 548   a_old_ck_helem      = PL_check[OP_HELEM];
 549   PL_check[OP_HELEM]  = MEMBER_TO_FPTR(a_ck_deref);
 550   a_old_ck_rv2sv      = PL_check[OP_RV2SV];
 551   PL_check[OP_RV2SV]  = MEMBER_TO_FPTR(a_ck_deref);
 552   a_old_ck_exists     = PL_check[OP_EXISTS];
 553   PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_ck_root);
 554   a_old_ck_delete     = PL_check[OP_DELETE];
 555   PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_ck_root);
 556
 557   stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
 558   newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
 559   newCONSTSUB(stash, "A_HINT_WARN",   newSVuv(A_HINT_WARN));
 560   newCONSTSUB(stash, "A_HINT_FETCH",  newSVuv(A_HINT_FETCH));
 561   newCONSTSUB(stash, "A_HINT_STORE",  newSVuv(A_HINT_STORE));
 562   newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
 563   newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
 564   newCONSTSUB(stash, "A_HINT_MASK",   newSVuv(A_HINT_MASK));
 565  }
 566 }
 567
 568 SV *
 569 _tag(SV *hint)
 570 PROTOTYPE: $
 571 CODE:
 572  RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
 573 OUTPUT:
 574  RETVAL
 575
 576 SV *
 577 _detag(SV *tag)
 578 PROTOTYPE: $
 579 CODE:
 580  if (!SvOK(tag))
 581   XSRETURN_UNDEF;
 582  RETVAL = newSVuv(a_detag(tag));
 583 OUTPUT:
 584  RETVAL