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