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_set_root(const OP *root, UV flags) {
 193  a_op_info *oi;
 194  const OP *o = root;
 195
 196 #ifdef USE_ITHREADS
 197  MUTEX_LOCK(&a_op_map_mutex);
 198 #endif
 199
 200  while (o) {
 201   if (oi = ptable_fetch(a_op_map, o)) {
 202    oi->root  = root;
 203    oi->flags = flags;
 204   }
 205   if (!(o->op_flags & OPf_KIDS))
 206    break;
 207   o = cUNOPo->op_first;
 208  }
 209
 210 #ifdef USE_ITHREADS
 211  MUTEX_UNLOCK(&a_op_map_mutex);
 212 #endif
 213 }
 214
 215 /* ... Lightweight pp_defined() ............................................ */
 216
 217 STATIC bool a_defined(pTHX_ SV *sv) {
 218 #define a_defined(S) a_defined(aTHX_ (S))
 219  bool defined = FALSE;
 220
 221  switch (SvTYPE(sv)) {
 222   case SVt_PVAV:
 223    if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
 224                       || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 225     defined = TRUE;
 226    break;
 227   case SVt_PVHV:
 228    if (HvARRAY(sv) || SvGMAGICAL(sv)
 229                    || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 230     defined = TRUE;
 231    break;
 232   default:
 233    defined = SvOK(sv);
 234  }
 235
 236  return defined;
 237 }
 238
 239 /* --- PP functions -------------------------------------------------------- */
 240
 241 /* ... pp_rv2av ............................................................ */
 242
 243 STATIC OP *a_pp_rv2av(pTHX) {
 244  a_op_info oi;
 245  UV hint;
 246  dSP;
 247
 248  if (!SvOK(TOPs)) {
 249   SV *av;
 250   POPs;
 251   av = sv_2mortal((SV *) newAV());
 252   PUSHs(av);
 253   RETURN;
 254  }
 255
 256  a_map_fetch(PL_op, &oi);
 257
 258  return CALL_FPTR(oi.old_pp)(aTHX);
 259 }
 260
 261 /* ... pp_rv2hv ............................................................ */
 262
 263 STATIC OP *a_pp_rv2hv(pTHX) {
 264  a_op_info oi;
 265  UV hint;
 266  dSP;
 267
 268  if (!SvOK(TOPs))
 269   RETURN;
 270
 271  a_map_fetch(PL_op, &oi);
 272
 273  return CALL_FPTR(oi.old_pp)(aTHX);
 274 }
 275
 276 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
 277
 278 STATIC const char a_msg_forbidden[]  = "Reference vivification forbidden";
 279 STATIC const char a_msg_impossible[] = "Can't vivify reference";
 280
 281 STATIC OP *a_pp_deref(pTHX) {
 282  a_op_info oi;
 283  UV flags;
 284  dSP;
 285
 286  a_map_fetch(PL_op, &oi);
 287  flags = oi.flags;
 288
 289  if (flags & A_HINT_DEREF) {
 290   OP *o;
 291   U8 old_private;
 292
 293 deref:
 294   old_private = PL_op->op_private;
 295   PL_op->op_private &= ~OPpDEREF;
 296   PL_op->op_private |= OPpLVAL_DEFER;
 297   o = CALL_FPTR(oi.old_pp)(aTHX);
 298   PL_op->op_private = old_private;
 299
 300   if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
 301    SPAGAIN;
 302    if (!SvOK(TOPs)) {
 303     if (flags & A_HINT_STRICT)
 304      croak(a_msg_forbidden);
 305     else if (flags & A_HINT_WARN)
 306       warn(a_msg_forbidden);
 307     else /* A_HINT_STORE */
 308      croak(a_msg_impossible);
 309    }
 310   }
 311
 312   return o;
 313  } else if (flags && (PL_op->op_private & OPpDEREF || PL_op == oi.root)) {
 314   oi.flags = flags & A_HINT_NOTIFY;
 315
 316   if (oi.root->op_flags & OPf_MOD) {
 317    if (flags & A_HINT_STORE)
 318     oi.flags |= (A_HINT_STORE|A_HINT_DEREF);
 319   } else if (flags & A_HINT_FETCH)
 320    oi.flags |= (A_HINT_FETCH|A_HINT_DEREF);
 321
 322   if (PL_op == oi.root)
 323    oi.flags &= ~A_HINT_DEREF;
 324
 325   /* We will need the updated flags value in the deref part */
 326   flags = oi.flags;
 327
 328   if (flags & A_HINT_DEREF)
 329    goto deref;
 330
 331   /* This op doesn't need to skip autovivification, so restore the original
 332    * state. Be aware that another extension might have saved a_pp_deref as the
 333    * ppaddr for this op, so restoring PL_op->op_ppaddr doesn't ensure that this
 334    * function will never be called again. That's why we don't remove the op info
 335    * from our map and we reset oi.flags to 0, so that it can still run correctly
 336    * if required. */
 337   oi.flags = 0;
 338   PL_op->op_ppaddr = oi.old_pp;
 339  }
 340
 341  return CALL_FPTR(oi.old_pp)(aTHX);
 342 }
 343
 344 /* ... pp_root (exists,delete) ............................................. */
 345
 346 STATIC OP *a_pp_root(pTHX) {
 347  a_op_info oi;
 348  dSP;
 349
 350  if (!a_defined(TOPm1s)) {
 351   POPs;
 352   POPs;
 353   if (PL_op->op_type == OP_EXISTS)
 354    RETPUSHNO;
 355   else
 356    RETPUSHUNDEF;
 357  }
 358
 359  a_map_fetch(PL_op, &oi);
 360
 361  return CALL_FPTR(oi.old_pp)(aTHX);
 362 }
 363
 364 /* --- Check functions ----------------------------------------------------- */
 365
 366 /* ... ck_pad{any,sv} ...................................................... */
 367
 368 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
 369  * function, but are instead manually mutated from a PADANY. This is why we set
 370  * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
 371  * their op_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
 372  * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
 373  * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
 374  * globally. */
 375
 376 STATIC OP *(*a_pp_padsv_saved)(pTHX) = 0;
 377
 378 STATIC void a_pp_padsv_save(void) {
 379  if (a_pp_padsv_saved)
 380   return;
 381
 382  a_pp_padsv_saved    = PL_ppaddr[OP_PADSV];
 383  PL_ppaddr[OP_PADSV] = a_pp_deref;
 384 }
 385
 386 STATIC void a_pp_padsv_restore(OP *o) {
 387  if (!a_pp_padsv_saved)
 388   return;
 389
 390  if (o->op_ppaddr == a_pp_deref)
 391   o->op_ppaddr = a_pp_padsv_saved;
 392
 393  PL_ppaddr[OP_PADSV] = a_pp_padsv_saved;
 394  a_pp_padsv_saved    = 0;
 395 }
 396
 397 STATIC OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
 398
 399 STATIC OP *a_ck_padany(pTHX_ OP *o) {
 400  UV hint;
 401
 402  a_pp_padsv_restore(o);
 403
 404  o = CALL_FPTR(a_old_ck_padany)(aTHX_ o);
 405
 406  hint = a_hint();
 407  if (hint & A_HINT_DO) {
 408   a_pp_padsv_save();
 409   a_map_store(o, a_pp_padsv_saved, hint);
 410  } else
 411   a_map_store(o, 0, 0);
 412
 413  return o;
 414 }
 415
 416 STATIC OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
 417
 418 STATIC OP *a_ck_padsv(pTHX_ OP *o) {
 419  UV hint;
 420
 421  a_pp_padsv_restore(o);
 422
 423  o = CALL_FPTR(a_old_ck_padsv)(aTHX_ o);
 424
 425  hint = a_hint();
 426  if (hint & A_HINT_DO) {
 427   a_map_store(o, o->op_ppaddr, hint);
 428   o->op_ppaddr = a_pp_deref;
 429  } else
 430   a_map_store(o, 0, 0);
 431
 432  return o;
 433 }
 434
 435 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
 436
 437 STATIC OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
 438 STATIC OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
 439 STATIC OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
 440
 441 STATIC OP *a_ck_deref(pTHX_ OP *o) {
 442  OP * (*old_ck)(pTHX_ OP *o) = 0;
 443  UV hint;
 444
 445  switch (o->op_type) {
 446   case OP_AELEM: old_ck = a_old_ck_aelem; break;
 447   case OP_HELEM: old_ck = a_old_ck_helem; break;
 448   case OP_RV2SV: old_ck = a_old_ck_rv2sv; break;
 449  }
 450  o = CALL_FPTR(old_ck)(aTHX_ o);
 451
 452  hint = a_hint();
 453  if (hint & A_HINT_DO) {
 454   if (!(hint & A_HINT_STRICT) && o->op_flags & OPf_KIDS) {
 455    OP *kid = cUNOPo->op_first;
 456    switch (kid->op_type) {
 457     case OP_RV2AV:
 458      a_map_store(kid, kid->op_ppaddr, hint);
 459      kid->op_ppaddr = a_pp_rv2av;
 460      break;
 461     case OP_RV2HV:
 462      a_map_store(kid, kid->op_ppaddr, hint);
 463      kid->op_ppaddr = a_pp_rv2hv;
 464      break;
 465    }
 466   }
 467   a_map_store(o, o->op_ppaddr, hint);
 468   o->op_ppaddr = a_pp_deref;
 469   a_map_set_root(o, hint);
 470  } else
 471   a_map_store(o, 0, 0);
 472
 473  return o;
 474 }
 475
 476 /* ... ck_root (exists,delete) ............................................. */
 477
 478 STATIC OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
 479 STATIC OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
 480
 481 STATIC OP *a_ck_root(pTHX_ OP *o) {
 482  OP * (*old_ck)(pTHX_ OP *o) = 0;
 483  bool enabled = FALSE;
 484  UV hint = a_hint();
 485
 486  switch (o->op_type) {
 487   case OP_EXISTS:
 488    old_ck  = a_old_ck_exists;
 489    enabled = hint & A_HINT_EXISTS;
 490    break;
 491   case OP_DELETE:
 492    old_ck  = a_old_ck_delete;
 493    enabled = hint & A_HINT_DELETE;
 494    break;
 495  }
 496  o = CALL_FPTR(old_ck)(aTHX_ o);
 497
 498  if (enabled) {
 499   a_map_set_root(o, hint | A_HINT_DEREF);
 500   a_map_store(o, o->op_ppaddr, hint);
 501   o->op_ppaddr = a_pp_root;
 502  } else {
 503   a_map_set_root(o, 0);
 504  }
 505
 506  return o;
 507 }
 508
 509 STATIC U32 a_initialized = 0;
 510
 511 /* --- XS ------------------------------------------------------------------ */
 512
 513 MODULE = autovivification      PACKAGE = autovivification
 514
 515 PROTOTYPES: ENABLE
 516
 517 BOOT:
 518 {
 519  if (!a_initialized++) {
 520   HV *stash;
 521
 522   a_op_map = ptable_new();
 523 #ifdef USE_ITHREADS
 524   MUTEX_INIT(&a_op_map_mutex);
 525 #endif
 526
 527   PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
 528
 529   a_old_ck_padany     = PL_check[OP_PADANY];
 530   PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_ck_padany);
 531   a_old_ck_padsv      = PL_check[OP_PADSV];
 532   PL_check[OP_PADSV]  = MEMBER_TO_FPTR(a_ck_padsv);
 533   a_old_ck_aelem      = PL_check[OP_AELEM];
 534   PL_check[OP_AELEM]  = MEMBER_TO_FPTR(a_ck_deref);
 535   a_old_ck_helem      = PL_check[OP_HELEM];
 536   PL_check[OP_HELEM]  = MEMBER_TO_FPTR(a_ck_deref);
 537   a_old_ck_rv2sv      = PL_check[OP_RV2SV];
 538   PL_check[OP_RV2SV]  = MEMBER_TO_FPTR(a_ck_deref);
 539   a_old_ck_exists     = PL_check[OP_EXISTS];
 540   PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_ck_root);
 541   a_old_ck_delete     = PL_check[OP_DELETE];
 542   PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_ck_root);
 543
 544   stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
 545   newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
 546   newCONSTSUB(stash, "A_HINT_WARN",   newSVuv(A_HINT_WARN));
 547   newCONSTSUB(stash, "A_HINT_FETCH",  newSVuv(A_HINT_FETCH));
 548   newCONSTSUB(stash, "A_HINT_STORE",  newSVuv(A_HINT_STORE));
 549   newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
 550   newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
 551   newCONSTSUB(stash, "A_HINT_MASK",   newSVuv(A_HINT_MASK));
 552  }
 553 }
 554
 555 SV *
 556 _tag(SV *hint)
 557 PROTOTYPE: $
 558 CODE:
 559  RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
 560 OUTPUT:
 561  RETVAL
 562
 563 SV *
 564 _detag(SV *tag)
 565 PROTOTYPE: $
 566 CODE:
 567  if (!SvOK(tag))
 568   XSRETURN_UNDEF;
 569  RETVAL = newSVuv(a_detag(tag));
 570 OUTPUT:
 571  RETVAL