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 #ifndef HvNAME_get
  15 # define HvNAME_get(H) HvNAME(H)
  16 #endif
  17
  18 #ifndef HvNAMELEN_get
  19 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
  20 #endif
  21
  22 #define A_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  23
  24 #ifndef A_WORKAROUND_REQUIRE_PROPAGATION
  25 # define A_WORKAROUND_REQUIRE_PROPAGATION !A_HAS_PERL(5, 10, 1)
  26 #endif
  27
  28 #ifndef A_HAS_RPEEP
  29 # define A_HAS_RPEEP A_HAS_PERL(5, 13, 5)
  30 #endif
  31
  32 #ifndef A_HAS_MULTIDEREF
  33 # define A_HAS_MULTIDEREF A_HAS_PERL(5, 21, 7)
  34 #endif
  35
  36 #ifndef OpSIBLING
  37 # ifdef OP_SIBLING
  38 #  define OpSIBLING(O) OP_SIBLING(O)
  39 # else
  40 #  define OpSIBLING(O) ((O)->op_sibling)
  41 # endif
  42 #endif
  43
  44 /* ... Thread safety and multiplicity ...................................... */
  45
  46 /* Always safe when the workaround isn't needed */
  47 #if !A_WORKAROUND_REQUIRE_PROPAGATION
  48 # undef A_FORKSAFE
  49 # define A_FORKSAFE 1
  50 /* Otherwise, safe unless Makefile.PL says it's Win32 */
  51 #elif !defined(A_FORKSAFE)
  52 # define A_FORKSAFE 1
  53 #endif
  54
  55 #ifndef A_MULTIPLICITY
  56 # if defined(MULTIPLICITY)
  57 #  define A_MULTIPLICITY 1
  58 # else
  59 #  define A_MULTIPLICITY 0
  60 # endif
  61 #endif
  62 #if A_MULTIPLICITY
  63 # ifndef PERL_IMPLICIT_CONTEXT
  64 #  error MULTIPLICITY builds must set PERL_IMPLICIT_CONTEXT
  65 # endif
  66 #endif
  67
  68 #ifndef tTHX
  69 # define tTHX PerlInterpreter*
  70 #endif
  71
  72 #if A_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))
  73 # define A_THREADSAFE 1
  74 # ifndef MY_CXT_CLONE
  75 #  define MY_CXT_CLONE \
  76     dMY_CXT_SV;                                                      \
  77     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  78     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  79     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  80 # endif
  81 #else
  82 # define A_THREADSAFE 0
  83 # undef  dMY_CXT
  84 # define dMY_CXT      dNOOP
  85 # undef  MY_CXT
  86 # define MY_CXT       a_globaldata
  87 # undef  START_MY_CXT
  88 # define START_MY_CXT static my_cxt_t MY_CXT;
  89 # undef  MY_CXT_INIT
  90 # define MY_CXT_INIT  NOOP
  91 # undef  MY_CXT_CLONE
  92 # define MY_CXT_CLONE NOOP
  93 #endif
  94
  95 #if A_THREADSAFE
  96 /* We must use preexistent global mutexes or we will never be able to destroy
  97  * them. */
  98 # if A_HAS_PERL(5, 9, 3)
  99 #  define A_LOADED_LOCK   MUTEX_LOCK(&PL_my_ctx_mutex)
 100 #  define A_LOADED_UNLOCK MUTEX_UNLOCK(&PL_my_ctx_mutex)
 101 # else
 102 #  define A_LOADED_LOCK   OP_REFCNT_LOCK
 103 #  define A_LOADED_UNLOCK OP_REFCNT_UNLOCK
 104 # endif
 105 #else
 106 # define A_LOADED_LOCK   NOOP
 107 # define A_LOADED_UNLOCK NOOP
 108 #endif
 109
 110 #if defined(OP_CHECK_MUTEX_LOCK) && defined(OP_CHECK_MUTEX_UNLOCK)
 111 # define A_CHECK_LOCK   OP_CHECK_MUTEX_LOCK
 112 # define A_CHECK_UNLOCK OP_CHECK_MUTEX_UNLOCK
 113 #elif A_HAS_PERL(5, 9, 3)
 114 # define A_CHECK_LOCK   OP_REFCNT_LOCK
 115 # define A_CHECK_UNLOCK OP_REFCNT_UNLOCK
 116 #else
 117 /* Before perl 5.9.3, indirect_ck_*() calls are already protected by the
 118  * A_LOADED mutex, which falls back to the OP_REFCNT mutex. Make sure we don't
 119  * lock it twice. */
 120 # define A_CHECK_LOCK   NOOP
 121 # define A_CHECK_UNLOCK NOOP
 122 #endif
 123
 124 typedef OP *(*a_ck_t)(pTHX_ OP *);
 125
 126 #ifdef wrap_op_checker
 127
 128 # define a_ck_replace(T, NC, OCP) wrap_op_checker((T), (NC), (OCP))
 129
 130 #else
 131
 132 static void a_ck_replace(pTHX_ OPCODE type, a_ck_t new_ck, a_ck_t *old_ck_p) {
 133 #define a_ck_replace(T, NC, OCP) a_ck_replace(aTHX_ (T), (NC), (OCP))
 134  A_CHECK_LOCK;
 135  if (!*old_ck_p) {
 136   *old_ck_p      = PL_check[type];
 137   PL_check[type] = new_ck;
 138  }
 139  A_CHECK_UNLOCK;
 140 }
 141
 142 #endif
 143
 144 static void a_ck_restore(pTHX_ OPCODE type, a_ck_t *old_ck_p) {
 145 #define a_ck_restore(T, OCP) a_ck_restore(aTHX_ (T), (OCP))
 146  A_CHECK_LOCK;
 147  if (*old_ck_p) {
 148   PL_check[type] = *old_ck_p;
 149   *old_ck_p      = 0;
 150  }
 151  A_CHECK_UNLOCK;
 152 }
 153
 154 /* --- Helpers ------------------------------------------------------------- */
 155
 156 /* ... Check if the module is loaded ....................................... */
 157
 158 static I32 a_loaded = 0;
 159
 160 #if A_THREADSAFE
 161
 162 #define PTABLE_NAME        ptable_loaded
 163 #define PTABLE_NEED_DELETE 1
 164 #define PTABLE_NEED_WALK   0
 165
 166 #include "ptable.h"
 167
 168 #define ptable_loaded_store(T, K, V) ptable_loaded_store(aPTBLMS_ (T), (K), (V))
 169 #define ptable_loaded_delete(T, K)   ptable_loaded_delete(aPTBLMS_ (T), (K))
 170 #define ptable_loaded_free(T)        ptable_loaded_free(aPTBLMS_ (T))
 171
 172 static ptable *a_loaded_cxts = NULL;
 173
 174 static int a_is_loaded(pTHX_ void *cxt) {
 175 #define a_is_loaded(C) a_is_loaded(aTHX_ (C))
 176  int res = 0;
 177
 178  A_LOADED_LOCK;
 179  if (a_loaded_cxts && ptable_fetch(a_loaded_cxts, cxt))
 180   res = 1;
 181  A_LOADED_UNLOCK;
 182
 183  return res;
 184 }
 185
 186 static int a_set_loaded_locked(pTHX_ void *cxt) {
 187 #define a_set_loaded_locked(C) a_set_loaded_locked(aTHX_ (C))
 188  int global_setup = 0;
 189
 190  if (a_loaded <= 0) {
 191   assert(a_loaded == 0);
 192   assert(!a_loaded_cxts);
 193   a_loaded_cxts = ptable_new();
 194   global_setup  = 1;
 195  }
 196  ++a_loaded;
 197  assert(a_loaded_cxts);
 198  ptable_loaded_store(a_loaded_cxts, cxt, cxt);
 199
 200  return global_setup;
 201 }
 202
 203 static int a_clear_loaded_locked(pTHX_ void *cxt) {
 204 #define a_clear_loaded_locked(C) a_clear_loaded_locked(aTHX_ (C))
 205  int global_teardown = 0;
 206
 207  if (a_loaded > 1) {
 208   assert(a_loaded_cxts);
 209   ptable_loaded_delete(a_loaded_cxts, cxt);
 210   --a_loaded;
 211  } else if (a_loaded_cxts) {
 212   assert(a_loaded == 1);
 213   ptable_loaded_free(a_loaded_cxts);
 214   a_loaded_cxts   = NULL;
 215   a_loaded        = 0;
 216   global_teardown = 1;
 217  }
 218
 219  return global_teardown;
 220 }
 221
 222 #else
 223
 224 #define a_is_loaded(C)           (a_loaded > 0)
 225 #define a_set_loaded_locked(C)   ((a_loaded++ <= 0) ? 1 : 0)
 226 #define a_clear_loaded_locked(C) ((--a_loaded <= 0) ? 1 : 0)
 227
 228 #endif
 229
 230 /* ... Thread-safe hints ................................................... */
 231
 232 #if A_WORKAROUND_REQUIRE_PROPAGATION
 233
 234 typedef struct {
 235  U32 bits;
 236  IV  require_tag;
 237 } a_hint_t;
 238
 239 #define A_HINT_FREE(H) PerlMemShared_free(H)
 240
 241 #if A_THREADSAFE
 242
 243 #define PTABLE_NAME        ptable_hints
 244 #define PTABLE_VAL_FREE(V) A_HINT_FREE(V)
 245 #define PTABLE_NEED_DELETE 0
 246 #define PTABLE_NEED_WALK   1
 247
 248 #define pPTBL  pTHX
 249 #define pPTBL_ pTHX_
 250 #define aPTBL  aTHX
 251 #define aPTBL_ aTHX_
 252
 253 #include "ptable.h"
 254
 255 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
 256 #define ptable_hints_free(T)        ptable_hints_free(aTHX_ (T))
 257
 258 #endif /* A_THREADSAFE */
 259
 260 #endif /* A_WORKAROUND_REQUIRE_PROPAGATION */
 261
 262 #define PTABLE_NAME        ptable_seen
 263 #define PTABLE_NEED_DELETE 0
 264 #define PTABLE_NEED_WALK   0
 265
 266 #include "ptable.h"
 267
 268 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
 269 #define ptable_seen_store(T, K, V) ptable_seen_store(aPTBLMS_ (T), (K), (V))
 270 #define ptable_seen_clear(T)       ptable_seen_clear(aPTBLMS_ (T))
 271 #define ptable_seen_free(T)        ptable_seen_free(aPTBLMS_ (T))
 272
 273 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 274
 275 typedef struct {
 276  peep_t  old_peep; /* This is actually the rpeep past 5.13.5 */
 277  ptable *seen;     /* It really is a ptable_seen */
 278 #if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
 279  ptable *tbl;      /* It really is a ptable_hints */
 280  tTHX    owner;
 281 #endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
 282 } my_cxt_t;
 283
 284 START_MY_CXT
 285
 286 #if A_WORKAROUND_REQUIRE_PROPAGATION
 287
 288 #if A_THREADSAFE
 289
 290 typedef struct {
 291  ptable       *tbl;
 292 #if A_HAS_PERL(5, 13, 2)
 293  CLONE_PARAMS *params;
 294 #else
 295  CLONE_PARAMS  params;
 296 #endif
 297 } a_ptable_clone_ud;
 298
 299 #if A_HAS_PERL(5, 13, 2)
 300 # define a_ptable_clone_ud_init(U, T, O) \
 301    (U).tbl    = (T); \
 302    (U).params = Perl_clone_params_new((O), aTHX)
 303 # define a_ptable_clone_ud_deinit(U) Perl_clone_params_del((U).params)
 304 # define a_dup_inc(S, U)             SvREFCNT_inc(sv_dup((S), (U)->params))
 305 #else
 306 # define a_ptable_clone_ud_init(U, T, O) \
 307    (U).tbl               = (T);     \
 308    (U).params.stashes    = newAV(); \
 309    (U).params.flags      = 0;       \
 310    (U).params.proto_perl = (O)
 311 # define a_ptable_clone_ud_deinit(U) SvREFCNT_dec((U).params.stashes)
 312 # define a_dup_inc(S, U)             SvREFCNT_inc(sv_dup((S), &((U)->params)))
 313 #endif
 314
 315 static void a_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
 316  a_ptable_clone_ud *ud = ud_;
 317  a_hint_t *h1 = ent->val;
 318  a_hint_t *h2;
 319
 320  h2              = PerlMemShared_malloc(sizeof *h2);
 321  h2->bits        = h1->bits;
 322  h2->require_tag = PTR2IV(a_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
 323
 324  ptable_hints_store(ud->tbl, ent->key, h2);
 325 }
 326
 327 #endif /* A_THREADSAFE */
 328
 329 static IV a_require_tag(pTHX) {
 330 #define a_require_tag() a_require_tag(aTHX)
 331  const CV *cv, *outside;
 332
 333  cv = PL_compcv;
 334
 335  if (!cv) {
 336   /* If for some reason the pragma is operational at run-time, try to discover
 337    * the current cv in use. */
 338   const PERL_SI *si;
 339
 340   for (si = PL_curstackinfo; si; si = si->si_prev) {
 341    I32 cxix;
 342
 343    for (cxix = si->si_cxix; cxix >= 0; --cxix) {
 344     const PERL_CONTEXT *cx = si->si_cxstack + cxix;
 345
 346     switch (CxTYPE(cx)) {
 347      case CXt_SUB:
 348      case CXt_FORMAT:
 349       /* The propagation workaround is only needed up to 5.10.0 and at that
 350        * time format and sub contexts were still identical. And even later the
 351        * cv members offsets should have been kept the same. */
 352       cv = cx->blk_sub.cv;
 353       goto get_enclosing_cv;
 354      case CXt_EVAL:
 355       cv = cx->blk_eval.cv;
 356       goto get_enclosing_cv;
 357      default:
 358       break;
 359     }
 360    }
 361   }
 362
 363   cv = PL_main_cv;
 364  }
 365
 366 get_enclosing_cv:
 367  for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
 368   cv = outside;
 369
 370  return PTR2IV(cv);
 371 }
 372
 373 static SV *a_tag(pTHX_ UV bits) {
 374 #define a_tag(B) a_tag(aTHX_ (B))
 375  a_hint_t *h;
 376 #if A_THREADSAFE
 377  dMY_CXT;
 378
 379  if (!MY_CXT.tbl)
 380   return newSViv(0);
 381 #endif /* A_THREADSAFE */
 382
 383  h              = PerlMemShared_malloc(sizeof *h);
 384  h->bits        = bits;
 385  h->require_tag = a_require_tag();
 386
 387 #if A_THREADSAFE
 388  /* We only need for the key to be an unique tag for looking up the value later
 389   * Allocated memory provides convenient unique identifiers, so that's why we
 390   * use the hint as the key itself. */
 391  ptable_hints_store(MY_CXT.tbl, h, h);
 392 #endif /* A_THREADSAFE */
 393
 394  return newSViv(PTR2IV(h));
 395 }
 396
 397 static UV a_detag(pTHX_ const SV *hint) {
 398 #define a_detag(H) a_detag(aTHX_ (H))
 399  a_hint_t *h;
 400 #if A_THREADSAFE
 401  dMY_CXT;
 402
 403  if (!MY_CXT.tbl)
 404   return 0;
 405 #endif /* A_THREADSAFE */
 406
 407  if (!(hint && SvIOK(hint)))
 408   return 0;
 409
 410  h = INT2PTR(a_hint_t *, SvIVX(hint));
 411 #if A_THREADSAFE
 412  h = ptable_fetch(MY_CXT.tbl, h);
 413 #endif /* A_THREADSAFE */
 414
 415  if (a_require_tag() != h->require_tag)
 416   return 0;
 417
 418  return h->bits;
 419 }
 420
 421 #else /* A_WORKAROUND_REQUIRE_PROPAGATION */
 422
 423 #define a_tag(B)   newSVuv(B)
 424 /* PVs fetched from the hints chain have their SvLEN set to zero, so get the UV
 425  * from a copy. */
 426 #define a_detag(H) \
 427  ((H)              \
 428   ? (SvIOK(H)      \
 429      ? SvUVX(H)    \
 430      : (SvPOK(H)   \
 431         ? sv_2uv(SvLEN(H) ? (H) : sv_mortalcopy(H)) \
 432         : 0        \
 433        )           \
 434      )             \
 435   : 0)
 436
 437 #endif /* !A_WORKAROUND_REQUIRE_PROPAGATION */
 438
 439 /* Used both for hints and op flags */
 440 #define A_HINT_STRICT 1
 441 #define A_HINT_WARN   2
 442 #define A_HINT_FETCH  4
 443 #define A_HINT_STORE  8
 444 #define A_HINT_EXISTS 16
 445 #define A_HINT_DELETE 32
 446 #define A_HINT_NOTIFY (A_HINT_STRICT|A_HINT_WARN)
 447 #define A_HINT_DO     (A_HINT_FETCH|A_HINT_STORE|A_HINT_EXISTS|A_HINT_DELETE)
 448 #define A_HINT_MASK   (A_HINT_NOTIFY|A_HINT_DO)
 449
 450 /* Only used in op flags */
 451 #define A_HINT_ROOT   64
 452 #define A_HINT_DEREF  128
 453
 454 static VOL U32 a_hash = 0;
 455
 456 static UV a_hint(pTHX) {
 457 #define a_hint() a_hint(aTHX)
 458  SV *hint;
 459 #ifdef cop_hints_fetch_pvn
 460  hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__, a_hash, 0);
 461 #elif A_HAS_PERL(5, 9, 5)
 462  hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
 463                                        NULL,
 464                                        __PACKAGE__, __PACKAGE_LEN__,
 465                                        0,
 466                                        a_hash);
 467 #else
 468  SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
 469  if (!val)
 470   return 0;
 471  hint = *val;
 472 #endif
 473  return a_detag(hint);
 474 }
 475
 476 /* ... op => info map ...................................................... */
 477
 478 typedef struct {
 479  OP   *(*old_pp)(pTHX);
 480  void   *next;
 481  UV      flags;
 482 } a_op_info;
 483
 484 #define PTABLE_NAME        ptable_map
 485 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
 486 #define PTABLE_NEED_DELETE 1
 487 #define PTABLE_NEED_WALK   0
 488
 489 #include "ptable.h"
 490
 491 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
 492 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
 493 #define ptable_map_delete(T, K)   ptable_map_delete(aPTBLMS_ (T), (K))
 494
 495 static ptable *a_op_map = NULL;
 496
 497 #ifdef USE_ITHREADS
 498
 499 #define dA_MAP_THX a_op_info a_op_map_tmp_oi
 500
 501 static perl_mutex a_op_map_mutex;
 502
 503 #define A_LOCK(M)   MUTEX_LOCK(M)
 504 #define A_UNLOCK(M) MUTEX_UNLOCK(M)
 505
 506 static const a_op_info *a_map_fetch(const OP *o, a_op_info *oi) {
 507  const a_op_info *val;
 508
 509  A_LOCK(&a_op_map_mutex);
 510
 511  val = ptable_fetch(a_op_map, o);
 512  if (val) {
 513   *oi = *val;
 514   val = oi;
 515  }
 516
 517  A_UNLOCK(&a_op_map_mutex);
 518
 519  return val;
 520 }
 521
 522 #define a_map_fetch(O) a_map_fetch((O), &a_op_map_tmp_oi)
 523
 524 #else /* USE_ITHREADS */
 525
 526 #define dA_MAP_THX dNOOP
 527
 528 #define A_LOCK(M)   NOOP
 529 #define A_UNLOCK(M) NOOP
 530
 531 #define a_map_fetch(O) ptable_fetch(a_op_map, (O))
 532
 533 #endif /* !USE_ITHREADS */
 534
 535 static const a_op_info *a_map_store_locked(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), void *next, UV flags) {
 536 #define a_map_store_locked(O, PP, N, F) a_map_store_locked(aPTBLMS_ (O), (PP), (N), (F))
 537  a_op_info *oi;
 538
 539  if (!(oi = ptable_fetch(a_op_map, o))) {
 540   oi = PerlMemShared_malloc(sizeof *oi);
 541   ptable_map_store(a_op_map, o, oi);
 542  }
 543
 544  oi->old_pp = old_pp;
 545  oi->next   = next;
 546  oi->flags  = flags;
 547
 548  return oi;
 549 }
 550
 551 static void a_map_store(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), void *next, UV flags) {
 552 #define a_map_store(O, PP, N, F) a_map_store(aPTBLMS_ (O), (PP), (N), (F))
 553  A_LOCK(&a_op_map_mutex);
 554
 555  a_map_store_locked(o, old_pp, next, flags);
 556
 557  A_UNLOCK(&a_op_map_mutex);
 558 }
 559
 560 static void a_map_delete(pTHX_ const OP *o) {
 561 #define a_map_delete(O) a_map_delete(aTHX_ (O))
 562  A_LOCK(&a_op_map_mutex);
 563
 564  ptable_map_delete(a_op_map, o);
 565
 566  A_UNLOCK(&a_op_map_mutex);
 567 }
 568
 569 static const OP *a_map_descend(const OP *o) {
 570  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 571   case OA_BASEOP:
 572   case OA_UNOP:
 573   case OA_BINOP:
 574   case OA_BASEOP_OR_UNOP:
 575    return cUNOPo->op_first;
 576   case OA_LIST:
 577   case OA_LISTOP:
 578    return cLISTOPo->op_last;
 579  }
 580
 581  return NULL;
 582 }
 583
 584 static void a_map_store_root(pPTBLMS_ const OP *root, OP *(*old_pp)(pTHX), UV flags) {
 585 #define a_map_store_root(R, PP, F) a_map_store_root(aPTBLMS_ (R), (PP), (F))
 586  const a_op_info *roi;
 587  a_op_info *oi;
 588  const OP *o = root;
 589
 590  A_LOCK(&a_op_map_mutex);
 591
 592  roi = a_map_store_locked(o, old_pp, (OP *) root, flags | A_HINT_ROOT);
 593
 594  while (o->op_flags & OPf_KIDS) {
 595   o = a_map_descend(o);
 596   if (!o)
 597    break;
 598   if ((oi = ptable_fetch(a_op_map, o))) {
 599    oi->flags &= ~A_HINT_ROOT;
 600    oi->next   = (a_op_info *) roi;
 601    break;
 602   }
 603  }
 604
 605  A_UNLOCK(&a_op_map_mutex);
 606
 607  return;
 608 }
 609
 610 static void a_map_update_flags_topdown(const OP *root, UV flags) {
 611  a_op_info *oi;
 612  const OP *o = root;
 613
 614  A_LOCK(&a_op_map_mutex);
 615
 616  flags &= ~A_HINT_ROOT;
 617
 618  do {
 619   if ((oi = ptable_fetch(a_op_map, o)))
 620    oi->flags = (oi->flags & A_HINT_ROOT) | flags;
 621   if (!(o->op_flags & OPf_KIDS))
 622    break;
 623   o = a_map_descend(o);
 624  } while (o);
 625
 626  A_UNLOCK(&a_op_map_mutex);
 627
 628  return;
 629 }
 630
 631 #define a_map_cancel(R) a_map_update_flags_topdown((R), 0)
 632
 633 static void a_map_update_flags_bottomup(const OP *o, UV flags, UV rflags) {
 634  a_op_info *oi;
 635
 636  A_LOCK(&a_op_map_mutex);
 637
 638  flags  &= ~A_HINT_ROOT;
 639  rflags |=  A_HINT_ROOT;
 640
 641  oi = ptable_fetch(a_op_map, o);
 642  while (!(oi->flags & A_HINT_ROOT)) {
 643   oi->flags = flags;
 644   oi        = oi->next;
 645  }
 646  oi->flags = rflags;
 647
 648  A_UNLOCK(&a_op_map_mutex);
 649
 650  return;
 651 }
 652
 653 /* ... Decide whether this expression should be autovivified or not ........ */
 654
 655 static UV a_map_resolve(const OP *o, const a_op_info *oi) {
 656  UV flags = 0, rflags;
 657  const OP *root;
 658  const a_op_info *roi = oi;
 659
 660  while (!(roi->flags & A_HINT_ROOT))
 661   roi = roi->next;
 662  if (!roi)
 663   goto cancel;
 664
 665  rflags = roi->flags & ~A_HINT_ROOT;
 666  if (!rflags)
 667   goto cancel;
 668
 669  root = roi->next;
 670  if (root->op_flags & OPf_MOD) {
 671   if (rflags & A_HINT_STORE)
 672    flags = (A_HINT_STORE|A_HINT_DEREF);
 673  } else if (rflags & A_HINT_FETCH)
 674    flags = (A_HINT_FETCH|A_HINT_DEREF);
 675
 676  if (!flags) {
 677 cancel:
 678   a_map_update_flags_bottomup(o, 0, 0);
 679   return 0;
 680  }
 681
 682  flags |= (rflags & A_HINT_NOTIFY);
 683  a_map_update_flags_bottomup(o, flags, 0);
 684
 685  return oi->flags & A_HINT_ROOT ? 0 : flags;
 686 }
 687
 688 /* ... Inspired from pp_defined() .......................................... */
 689
 690 static int a_undef(pTHX_ SV *sv) {
 691 #define a_undef(S) a_undef(aTHX_ (S))
 692  switch (SvTYPE(sv)) {
 693   case SVt_NULL:
 694    return 1;
 695   case SVt_PVAV:
 696    if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
 697                       || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 698     return 0;
 699    break;
 700   case SVt_PVHV:
 701    if (HvARRAY(sv) || SvGMAGICAL(sv)
 702                    || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 703     return 0;
 704    break;
 705   default:
 706    SvGETMAGIC(sv);
 707    if (SvOK(sv))
 708     return 0;
 709  }
 710
 711  return 1;
 712 }
 713
 714 /* --- PP functions -------------------------------------------------------- */
 715
 716 /* Be aware that we restore PL_op->op_ppaddr from the pointer table old_pp
 717  * value, another extension might have saved our pp replacement as the ppaddr
 718  * for this op, so this doesn't ensure that our function will never be called
 719  * again. That's why we don't remove the op info from our map, so that it can
 720  * still run correctly if required. */
 721
 722 /* ... pp_rv2av ............................................................ */
 723
 724 static OP *a_pp_rv2av(pTHX) {
 725  dA_MAP_THX;
 726  const a_op_info *oi;
 727  dSP;
 728
 729  oi = a_map_fetch(PL_op);
 730
 731  if (oi->flags & A_HINT_DEREF) {
 732   if (a_undef(TOPs)) {
 733    /* We always need to push an empty array to fool the pp_aelem() that comes
 734     * later. */
 735    SV *av;
 736    (void) POPs;
 737    av = sv_2mortal((SV *) newAV());
 738    PUSHs(av);
 739    RETURN;
 740   }
 741  }
 742
 743  return oi->old_pp(aTHX);
 744 }
 745
 746 /* ... pp_rv2hv ............................................................ */
 747
 748 static OP *a_pp_rv2hv_simple(pTHX) {
 749  dA_MAP_THX;
 750  const a_op_info *oi;
 751  dSP;
 752
 753  oi = a_map_fetch(PL_op);
 754
 755  if (oi->flags & A_HINT_DEREF) {
 756   if (a_undef(TOPs))
 757    RETURN;
 758  }
 759
 760  return oi->old_pp(aTHX);
 761 }
 762
 763 static OP *a_pp_rv2hv(pTHX) {
 764  dA_MAP_THX;
 765  const a_op_info *oi;
 766  dSP;
 767
 768  oi = a_map_fetch(PL_op);
 769
 770  if (oi->flags & A_HINT_DEREF) {
 771   if (a_undef(TOPs)) {
 772    SV *hv;
 773    (void) POPs;
 774    hv = sv_2mortal((SV *) newHV());
 775    PUSHs(hv);
 776    RETURN;
 777   }
 778  }
 779
 780  return oi->old_pp(aTHX);
 781 }
 782
 783 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
 784
 785 static void a_cannot_vivify(pTHX_ UV flags) {
 786 #define a_cannot_vivify(F) a_cannot_vivify(aTHX_ (F))
 787  if (flags & A_HINT_STRICT)
 788   croak("Reference vivification forbidden");
 789  else if (flags & A_HINT_WARN)
 790   warn("Reference was vivified");
 791  else /* A_HINT_STORE */
 792   croak("Can't vivify reference");
 793 }
 794
 795 static OP *a_pp_deref(pTHX) {
 796  dA_MAP_THX;
 797  const a_op_info *oi;
 798  UV flags;
 799  dSP;
 800
 801  oi = a_map_fetch(PL_op);
 802
 803  flags = oi->flags;
 804  if (flags & A_HINT_DEREF) {
 805   OP *o;
 806
 807   o = oi->old_pp(aTHX);
 808
 809   if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
 810    SPAGAIN;
 811    if (a_undef(TOPs))
 812     a_cannot_vivify(flags);
 813   }
 814
 815   return o;
 816  }
 817
 818  return oi->old_pp(aTHX);
 819 }
 820
 821 /* ... pp_root (exists,delete,keys,values) ................................. */
 822
 823 static OP *a_pp_root_unop(pTHX) {
 824  dSP;
 825
 826  if (a_undef(TOPs)) {
 827   (void) POPs;
 828   /* Can only be reached by keys or values */
 829   if (GIMME_V == G_SCALAR) {
 830    dTARGET;
 831    PUSHi(0);
 832   }
 833   RETURN;
 834  }
 835
 836  {
 837   dA_MAP_THX;
 838   const a_op_info *oi = a_map_fetch(PL_op);
 839   return oi->old_pp(aTHX);
 840  }
 841 }
 842
 843 static OP *a_pp_root_binop(pTHX) {
 844  dSP;
 845
 846  if (a_undef(TOPm1s)) {
 847   (void) POPs;
 848   (void) POPs;
 849   if (PL_op->op_type == OP_EXISTS)
 850    RETPUSHNO;
 851   else
 852    RETPUSHUNDEF;
 853  }
 854
 855  {
 856   dA_MAP_THX;
 857   const a_op_info *oi = a_map_fetch(PL_op);
 858   return oi->old_pp(aTHX);
 859  }
 860 }
 861
 862 #if A_HAS_MULTIDEREF
 863
 864 /* ... pp_multideref ....................................................... */
 865
 866 /* This pp replacement is actually only called for topmost exists/delete ops,
 867  * because we hijack the [ah]elem check functions and this disables the
 868  * optimization for lvalue and rvalue dereferencing. In particular, the
 869  * OPf_MOD branches should never be covered. In the future, the multideref
 870  * optimization might also be disabled for custom exists/delete check functions,
 871  * which will make this section unnecessary. However, the code tries to be as
 872  * general as possible in case I think of a way to reenable the multideref
 873  * optimization even when this module is in use. */
 874
 875 static UV a_do_multideref(const OP *o, UV flags) {
 876  UV isexdel, other_flags;
 877
 878  assert(o->op_type == OP_MULTIDEREF);
 879
 880  other_flags = flags & ~A_HINT_DO;
 881
 882  isexdel = o->op_private & (OPpMULTIDEREF_EXISTS|OPpMULTIDEREF_DELETE);
 883  if (isexdel) {
 884   if (isexdel & OPpMULTIDEREF_EXISTS) {
 885    flags &= A_HINT_EXISTS;
 886   } else {
 887    flags &= A_HINT_DELETE;
 888   }
 889  } else {
 890   if (o->op_flags & OPf_MOD) {
 891    flags &= A_HINT_STORE;
 892   } else {
 893    flags &= A_HINT_FETCH;
 894   }
 895  }
 896
 897  return flags ? (flags | other_flags) : 0;
 898 }
 899
 900 static SV *a_do_fake_pp(pTHX_ OP *op) {
 901 #define a_do_fake_pp(O) a_do_fake_pp(aTHX_ (O))
 902  {
 903   OP *o = PL_op;
 904   ENTER;
 905   SAVEOP();
 906   PL_op = op;
 907   PL_op->op_ppaddr(aTHX);
 908   PL_op = o;
 909   LEAVE;
 910  }
 911
 912  {
 913   SV *ret;
 914   dSP;
 915   ret = POPs;
 916   PUTBACK;
 917   return ret;
 918  }
 919 }
 920
 921 static void a_do_fake_pp_unop_init(pTHX_ UNOP *unop, U32 type, U32 flags) {
 922 #define a_do_fake_pp_unop_init(O, T, F) a_do_fake_pp_unop_init(aTHX_ (O), (T), (F))
 923  unop->op_type    = type;
 924  unop->op_flags   = OPf_WANT_SCALAR | (~OPf_WANT & flags);
 925  unop->op_private = 0;
 926  unop->op_first   = NULL;
 927  unop->op_ppaddr  = PL_ppaddr[type];
 928 }
 929
 930 static SV *a_do_fake_pp_unop_arg1(pTHX_ U32 type, U32 flags, SV *arg) {
 931 #define a_do_fake_pp_unop_arg1(T, F, A) a_do_fake_pp_unop_arg1(aTHX_ (T), (F), (A))
 932  UNOP unop;
 933  dSP;
 934
 935  a_do_fake_pp_unop_init(&unop, type, flags);
 936
 937  EXTEND(SP, 1);
 938  PUSHs(arg);
 939  PUTBACK;
 940
 941  return a_do_fake_pp((OP *) &unop);
 942 }
 943
 944 static SV *a_do_fake_pp_unop_arg2(pTHX_ U32 type, U32 flags, SV *arg1, SV *arg2) {
 945 #define a_do_fake_pp_unop_arg2(T, F, A1, A2) a_do_fake_pp_unop_arg2(aTHX_ (T), (F), (A1), (A2))
 946  UNOP unop;
 947  dSP;
 948
 949  a_do_fake_pp_unop_init(&unop, type, flags);
 950
 951  EXTEND(SP, 2);
 952  PUSHs(arg1);
 953  PUSHs(arg2);
 954  PUTBACK;
 955
 956  return a_do_fake_pp((OP *) &unop);
 957 }
 958
 959 #define a_do_pp_rv2av(R)        a_do_fake_pp_unop_arg1(OP_RV2AV,  OPf_REF,     (R))
 960 #define a_do_pp_afetch(A, I)    a_do_fake_pp_unop_arg2(OP_AELEM,  0,           (A), (I))
 961 #define a_do_pp_afetch_lv(A, I) a_do_fake_pp_unop_arg2(OP_AELEM,  OPf_MOD,     (A), (I))
 962 #define a_do_pp_aexists(A, I)   a_do_fake_pp_unop_arg2(OP_EXISTS, OPf_SPECIAL, (A), (I))
 963 #define a_do_pp_adelete(A, I)   a_do_fake_pp_unop_arg2(OP_DELETE, OPf_SPECIAL, (A), (I))
 964
 965 #define a_do_pp_rv2hv(R)        a_do_fake_pp_unop_arg1(OP_RV2HV,  OPf_REF, (R))
 966 #define a_do_pp_hfetch(H, K)    a_do_fake_pp_unop_arg2(OP_HELEM,  0,       (H), (K))
 967 #define a_do_pp_hfetch_lv(H, K) a_do_fake_pp_unop_arg2(OP_HELEM,  OPf_MOD, (H), (K))
 968 #define a_do_pp_hexists(H, K)   a_do_fake_pp_unop_arg2(OP_EXISTS, 0,  (H), (K))
 969 #define a_do_pp_hdelete(H, K)   a_do_fake_pp_unop_arg2(OP_DELETE, 0,  (H), (K))
 970
 971 static OP *a_pp_multideref(pTHX) {
 972  UNOP_AUX_item *items;
 973  UV  actions;
 974  UV  flags = 0;
 975  SV *sv    = NULL;
 976  dSP;
 977
 978  {
 979   dA_MAP_THX;
 980   const a_op_info *oi = a_map_fetch(PL_op);
 981   assert(oi);
 982   flags = a_do_multideref(PL_op, oi->flags);
 983   if (!flags)
 984    return oi->old_pp(aTHX);
 985  }
 986
 987  items   = cUNOP_AUXx(PL_op)->op_aux;
 988  actions = items->uv;
 989
 990  PL_multideref_pc = items;
 991
 992  while (1) {
 993   switch (actions & MDEREF_ACTION_MASK) {
 994    case MDEREF_reload:
 995     actions = (++items)->uv;
 996     continue;
 997    case MDEREF_AV_padav_aelem: /* $lex[...] */
 998     sv = PAD_SVl((++items)->pad_offset);
 999     if (a_undef(sv))
1000      goto ret_undef;
1001     goto do_AV_aelem;
1002    case MDEREF_AV_gvav_aelem: /* $pkg[...] */
1003     sv = UNOP_AUX_item_sv(++items);
1004     assert(isGV_with_GP(sv));
1005     sv = (SV *) GvAVn((GV *) sv);
1006     if (a_undef(sv))
1007      goto ret_undef;
1008     goto do_AV_aelem;
1009    case MDEREF_AV_pop_rv2av_aelem: /* expr->[...] */
1010     sv = POPs;
1011     if (a_undef(sv))
1012      goto ret_undef;
1013     goto do_AV_rv2av_aelem;
1014    case MDEREF_AV_gvsv_vivify_rv2av_aelem: /* $pkg->[...] */
1015     sv = UNOP_AUX_item_sv(++items);
1016     assert(isGV_with_GP(sv));
1017     sv = GvSVn((GV *) sv);
1018     if (a_undef(sv))
1019      goto ret_undef;
1020     goto do_AV_vivify_rv2av_aelem;
1021    case MDEREF_AV_padsv_vivify_rv2av_aelem: /* $lex->[...] */
1022     sv = PAD_SVl((++items)->pad_offset);
1023     /* FALLTHROUGH */
1024    case MDEREF_AV_vivify_rv2av_aelem: /* vivify, ->[...] */
1025     if (a_undef(sv))
1026      goto ret_undef;
1027 do_AV_vivify_rv2av_aelem:
1028     sv = Perl_vivify_ref(aTHX_ sv, OPpDEREF_AV);
1029 do_AV_rv2av_aelem:
1030     sv = a_do_pp_rv2av(sv);
1031 do_AV_aelem:
1032     {
1033      SV *esv;
1034      assert(SvTYPE(sv) == SVt_PVAV);
1035      switch (actions & MDEREF_INDEX_MASK) {
1036       case MDEREF_INDEX_none:
1037        goto finish;
1038       case MDEREF_INDEX_const:
1039        esv = sv_2mortal(newSViv((++items)->iv));
1040        break;
1041       case MDEREF_INDEX_padsv:
1042        esv = PAD_SVl((++items)->pad_offset);
1043        goto check_elem;
1044       case MDEREF_INDEX_gvsv:
1045        esv = UNOP_AUX_item_sv(++items);
1046        assert(isGV_with_GP(esv));
1047        esv = GvSVn((GV *) esv);
1048 check_elem:
1049        if (UNLIKELY(SvROK(esv) && !SvGAMAGIC(esv) && ckWARN(WARN_MISC)))
1050         Perl_warner(aTHX_ packWARN(WARN_MISC),
1051                           "Use of reference \"%"SVf"\" as array index",
1052                           SVfARG(esv));
1053        break;
1054      }
1055      PL_multideref_pc = items;
1056      if (actions & MDEREF_FLAG_last) {
1057       switch (flags & A_HINT_DO) {
1058        case A_HINT_FETCH:
1059         sv = a_do_pp_afetch(sv, esv);
1060         break;
1061        case A_HINT_STORE:
1062         sv = a_do_pp_afetch_lv(sv, esv);
1063         break;
1064        case A_HINT_EXISTS:
1065         sv = a_do_pp_aexists(sv, esv);
1066         break;
1067        case A_HINT_DELETE:
1068         sv = a_do_pp_adelete(sv, esv);
1069         break;
1070       }
1071       goto finish;
1072      }
1073      sv = a_do_pp_afetch(sv, esv);
1074      break;
1075     }
1076    case MDEREF_HV_padhv_helem: /* $lex{...} */
1077     sv = PAD_SVl((++items)->pad_offset);
1078     if (a_undef(sv))
1079      goto ret_undef;
1080     goto do_HV_helem;
1081    case MDEREF_HV_gvhv_helem: /* $pkg{...} */
1082     sv = UNOP_AUX_item_sv(++items);
1083     assert(isGV_with_GP(sv));
1084     sv = (SV *) GvHVn((GV *) sv);
1085     if (a_undef(sv))
1086      goto ret_undef;
1087     goto do_HV_helem;
1088    case MDEREF_HV_pop_rv2hv_helem: /* expr->{...} */
1089     sv = POPs;
1090     if (a_undef(sv))
1091      goto ret_undef;
1092     goto do_HV_rv2hv_helem;
1093    case MDEREF_HV_gvsv_vivify_rv2hv_helem: /* $pkg->{...} */
1094     sv = UNOP_AUX_item_sv(++items);
1095     assert(isGV_with_GP(sv));
1096     sv = GvSVn((GV *) sv);
1097     if (a_undef(sv))
1098      goto ret_undef;
1099     goto do_HV_vivify_rv2hv_helem;
1100    case MDEREF_HV_padsv_vivify_rv2hv_helem: /* $lex->{...} */
1101     sv = PAD_SVl((++items)->pad_offset);
1102     /* FALLTHROUGH */
1103    case MDEREF_HV_vivify_rv2hv_helem: /* vivify, ->{...} */
1104     if (a_undef(sv))
1105      goto ret_undef;
1106 do_HV_vivify_rv2hv_helem:
1107     sv = Perl_vivify_ref(aTHX_ sv, OPpDEREF_HV);
1108 do_HV_rv2hv_helem:
1109     sv = a_do_pp_rv2hv(sv);
1110 do_HV_helem:
1111     {
1112      SV *key;
1113      assert(SvTYPE(sv) == SVt_PVHV);
1114      switch (actions & MDEREF_INDEX_MASK) {
1115       case MDEREF_INDEX_none:
1116        goto finish;
1117       case MDEREF_INDEX_const:
1118        key = UNOP_AUX_item_sv(++items);
1119        break;
1120       case MDEREF_INDEX_padsv:
1121        key = PAD_SVl((++items)->pad_offset);
1122        break;
1123       case MDEREF_INDEX_gvsv:
1124        key = UNOP_AUX_item_sv(++items);
1125        assert(isGV_with_GP(key));
1126        key = GvSVn((GV *) key);
1127        break;
1128      }
1129      PL_multideref_pc = items;
1130      if (actions & MDEREF_FLAG_last) {
1131       switch (flags & A_HINT_DO) {
1132        case A_HINT_FETCH:
1133         sv = a_do_pp_hfetch(sv, key);
1134         break;
1135        case A_HINT_STORE:
1136         sv = a_do_pp_hfetch_lv(sv, key);
1137         break;
1138        case A_HINT_EXISTS:
1139         sv = a_do_pp_hexists(sv, key);
1140         break;
1141        case A_HINT_DELETE:
1142         sv = a_do_pp_hdelete(sv, key);
1143         break;
1144        default:
1145         break;
1146       }
1147       goto finish;
1148      }
1149      sv = a_do_pp_hfetch(sv, key);
1150      break;
1151     }
1152   }
1153
1154   actions >>= MDEREF_SHIFT;
1155  }
1156
1157 ret_undef:
1158  if (flags & (A_HINT_NOTIFY|A_HINT_STORE))
1159   a_cannot_vivify(flags);
1160  if (flags & A_HINT_EXISTS)
1161   sv = &PL_sv_no;
1162  else
1163   sv = &PL_sv_undef;
1164 finish:
1165  XPUSHs(sv);
1166  RETURN;
1167 }
1168
1169 #endif /* A_HAS_MULTIDEREF */
1170
1171 /* --- Check functions ----------------------------------------------------- */
1172
1173 static void a_recheck_rv2xv(pTHX_ OP *o, OPCODE type, OP *(*new_pp)(pTHX)) {
1174 #define a_recheck_rv2xv(O, T, PP) a_recheck_rv2xv(aTHX_ (O), (T), (PP))
1175
1176  if (o->op_type == type && o->op_ppaddr != new_pp
1177                         && cUNOPo->op_first->op_type != OP_GV) {
1178   dA_MAP_THX;
1179   const a_op_info *oi = a_map_fetch(o);
1180   if (oi) {
1181    a_map_store(o, o->op_ppaddr, oi->next, oi->flags);
1182    o->op_ppaddr = new_pp;
1183   }
1184  }
1185
1186  return;
1187 }
1188
1189 /* ... ck_pad{any,sv} ...................................................... */
1190
1191 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
1192  * function, but are instead manually mutated from a padany. So we store
1193  * the op entry in the op map in the padany check function, and we set their
1194  * op_ppaddr member in our peephole optimizer replacement below. */
1195
1196 static OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
1197
1198 static OP *a_ck_padany(pTHX_ OP *o) {
1199  UV hint;
1200
1201  o = a_old_ck_padany(aTHX_ o);
1202
1203  hint = a_hint();
1204  if (hint & A_HINT_DO)
1205   a_map_store_root(o, o->op_ppaddr, hint);
1206  else
1207   a_map_delete(o);
1208
1209  return o;
1210 }
1211
1212 static OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
1213
1214 static OP *a_ck_padsv(pTHX_ OP *o) {
1215  UV hint;
1216
1217  o = a_old_ck_padsv(aTHX_ o);
1218
1219  hint = a_hint();
1220  if (hint & A_HINT_DO) {
1221   a_map_store_root(o, o->op_ppaddr, hint);
1222   o->op_ppaddr = a_pp_deref;
1223  } else
1224   a_map_delete(o);
1225
1226  return o;
1227 }
1228
1229 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
1230
1231 /* Those ops appear both at the root and inside an expression but there's no
1232  * way to distinguish both situations. Worse, we can't even know if we are in a
1233  * modifying context, so the expression can't be resolved yet. It will be at the
1234  * first invocation of a_pp_deref() for this expression. */
1235
1236 static OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
1237 static OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
1238 static OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
1239
1240 static OP *a_ck_deref(pTHX_ OP *o) {
1241  OP * (*old_ck)(pTHX_ OP *o) = 0;
1242  UV hint = a_hint();
1243
1244  switch (o->op_type) {
1245   case OP_AELEM:
1246    old_ck = a_old_ck_aelem;
1247    if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT))
1248     a_recheck_rv2xv(cUNOPo->op_first, OP_RV2AV, a_pp_rv2av);
1249    break;
1250   case OP_HELEM:
1251    old_ck = a_old_ck_helem;
1252    if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT))
1253     a_recheck_rv2xv(cUNOPo->op_first, OP_RV2HV, a_pp_rv2hv_simple);
1254    break;
1255   case OP_RV2SV:
1256    old_ck = a_old_ck_rv2sv;
1257    break;
1258  }
1259  o = old_ck(aTHX_ o);
1260
1261 #if A_HAS_MULTIDEREF
1262  if (old_ck == a_old_ck_rv2sv && o->op_flags & OPf_KIDS) {
1263   OP *kid = cUNOPo->op_first;
1264   if (kid && kid->op_type == OP_GV) {
1265    if (hint & A_HINT_DO)
1266     a_map_store(kid, kid->op_ppaddr, NULL, hint);
1267    else
1268     a_map_delete(kid);
1269   }
1270  }
1271 #endif
1272
1273  if (hint & A_HINT_DO) {
1274   a_map_store_root(o, o->op_ppaddr, hint);
1275   o->op_ppaddr = a_pp_deref;
1276  } else
1277   a_map_delete(o);
1278
1279  return o;
1280 }
1281
1282 /* ... ck_rv2xv (rv2av,rv2hv) .............................................. */
1283
1284 /* Those ops also appear both inisde and at the root, hence the caveats for
1285  * a_ck_deref() still apply here. Since a padsv/rv2sv must appear before a
1286  * rv2[ah]v, resolution is handled by the first call to a_pp_deref() in the
1287  * expression. */
1288
1289 static OP *(*a_old_ck_rv2av)(pTHX_ OP *) = 0;
1290 static OP *(*a_old_ck_rv2hv)(pTHX_ OP *) = 0;
1291
1292 static OP *a_ck_rv2xv(pTHX_ OP *o) {
1293  OP * (*old_ck)(pTHX_ OP *o) = 0;
1294  OP * (*new_pp)(pTHX)        = 0;
1295  UV hint;
1296
1297  switch (o->op_type) {
1298   case OP_RV2AV: old_ck = a_old_ck_rv2av; new_pp = a_pp_rv2av; break;
1299   case OP_RV2HV: old_ck = a_old_ck_rv2hv; new_pp = a_pp_rv2hv_simple; break;
1300  }
1301  o = old_ck(aTHX_ o);
1302
1303  if (cUNOPo->op_first->op_type == OP_GV)
1304   return o;
1305
1306  hint = a_hint();
1307  if (hint & A_HINT_DO && !(hint & A_HINT_STRICT)) {
1308   a_map_store_root(o, o->op_ppaddr, hint);
1309   o->op_ppaddr = new_pp;
1310  } else
1311   a_map_delete(o);
1312
1313  return o;
1314 }
1315
1316 /* ... ck_xslice (aslice,hslice) ........................................... */
1317
1318 /* I think those are only found at the root, but there's nothing that really
1319  * prevent them to be inside the expression too. We only need to update the
1320  * root so that the rest of the expression will see the right context when
1321  * resolving. That's why we don't replace the ppaddr. */
1322
1323 static OP *(*a_old_ck_aslice)(pTHX_ OP *) = 0;
1324 static OP *(*a_old_ck_hslice)(pTHX_ OP *) = 0;
1325
1326 static OP *a_ck_xslice(pTHX_ OP *o) {
1327  OP * (*old_ck)(pTHX_ OP *o) = 0;
1328  UV hint = a_hint();
1329
1330  switch (o->op_type) {
1331   case OP_ASLICE:
1332    old_ck = a_old_ck_aslice;
1333    break;
1334   case OP_HSLICE:
1335    old_ck = a_old_ck_hslice;
1336    if (hint & A_HINT_DO)
1337     a_recheck_rv2xv(OpSIBLING(cUNOPo->op_first), OP_RV2HV, a_pp_rv2hv);
1338    break;
1339  }
1340  o = old_ck(aTHX_ o);
1341
1342  if (hint & A_HINT_DO) {
1343   a_map_store_root(o, 0, hint);
1344  } else
1345   a_map_delete(o);
1346
1347  return o;
1348 }
1349
1350 /* ... ck_root (exists,delete,keys,values) ................................. */
1351
1352 /* Those ops are only found at the root of a dereferencing expression. We can
1353  * then resolve at compile time if vivification must take place or not. */
1354
1355 static OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
1356 static OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
1357 static OP *(*a_old_ck_keys)  (pTHX_ OP *) = 0;
1358 static OP *(*a_old_ck_values)(pTHX_ OP *) = 0;
1359
1360 static OP *a_ck_root(pTHX_ OP *o) {
1361  OP * (*old_ck)(pTHX_ OP *o) = 0;
1362  OP * (*new_pp)(pTHX)        = 0;
1363  bool enabled = FALSE;
1364  UV hint = a_hint();
1365
1366  switch (o->op_type) {
1367   case OP_EXISTS:
1368    old_ck  = a_old_ck_exists;
1369    new_pp  = a_pp_root_binop;
1370    enabled = hint & A_HINT_EXISTS;
1371    break;
1372   case OP_DELETE:
1373    old_ck  = a_old_ck_delete;
1374    new_pp  = a_pp_root_binop;
1375    enabled = hint & A_HINT_DELETE;
1376    break;
1377   case OP_KEYS:
1378    old_ck  = a_old_ck_keys;
1379    new_pp  = a_pp_root_unop;
1380    enabled = hint & A_HINT_FETCH;
1381    break;
1382   case OP_VALUES:
1383    old_ck  = a_old_ck_values;
1384    new_pp  = a_pp_root_unop;
1385    enabled = hint & A_HINT_FETCH;
1386    break;
1387  }
1388  o = old_ck(aTHX_ o);
1389
1390  if (hint & A_HINT_DO) {
1391   if (enabled) {
1392    a_map_update_flags_topdown(o, hint | A_HINT_DEREF);
1393    a_map_store_root(o, o->op_ppaddr, hint);
1394    o->op_ppaddr = new_pp;
1395   } else {
1396    a_map_cancel(o);
1397   }
1398  } else
1399   a_map_delete(o);
1400
1401  return o;
1402 }
1403
1404 /* ... Our peephole optimizer .............................................. */
1405
1406 static void a_peep_rec(pTHX_ OP *o, ptable *seen);
1407
1408 static void a_peep_rec(pTHX_ OP *o, ptable *seen) {
1409 #define a_peep_rec(O) a_peep_rec(aTHX_ (O), seen)
1410  for (; o; o = o->op_next) {
1411   dA_MAP_THX;
1412   const a_op_info *oi = NULL;
1413   UV flags = 0;
1414
1415 #if !A_HAS_RPEEP
1416   if (ptable_fetch(seen, o))
1417    break;
1418   ptable_seen_store(seen, o, o);
1419 #endif
1420
1421   switch (o->op_type) {
1422 #if A_HAS_RPEEP
1423    case OP_NEXTSTATE:
1424    case OP_DBSTATE:
1425    case OP_STUB:
1426    case OP_UNSTACK:
1427     if (ptable_fetch(seen, o))
1428      return;
1429     ptable_seen_store(seen, o, o);
1430     break;
1431 #endif
1432    case OP_PADSV:
1433     if (o->op_ppaddr != a_pp_deref) {
1434      oi = a_map_fetch(o);
1435      if (oi && (oi->flags & A_HINT_DO)) {
1436       a_map_store(o, o->op_ppaddr, oi->next, oi->flags);
1437       o->op_ppaddr = a_pp_deref;
1438      }
1439     }
1440     /* FALLTHROUGH */
1441    case OP_AELEM:
1442    case OP_AELEMFAST:
1443    case OP_HELEM:
1444    case OP_RV2SV:
1445     if (o->op_ppaddr != a_pp_deref)
1446      break;
1447     oi = a_map_fetch(o);
1448     if (!oi)
1449      break;
1450     flags = oi->flags;
1451     if (!(flags & A_HINT_DEREF)
1452         && (flags & A_HINT_DO)
1453         && (o->op_private & OPpDEREF || flags & A_HINT_ROOT)) {
1454      /* Decide if the expression must autovivify or not. */
1455      flags = a_map_resolve(o, oi);
1456     }
1457     if (flags & A_HINT_DEREF)
1458      o->op_private = ((o->op_private & ~OPpDEREF) | OPpLVAL_DEFER);
1459     else
1460      o->op_ppaddr  = oi->old_pp;
1461     break;
1462    case OP_RV2AV:
1463    case OP_RV2HV:
1464     if (   o->op_ppaddr != a_pp_rv2av
1465         && o->op_ppaddr != a_pp_rv2hv
1466         && o->op_ppaddr != a_pp_rv2hv_simple)
1467      break;
1468     oi = a_map_fetch(o);
1469     if (!oi)
1470      break;
1471     if (!(oi->flags & A_HINT_DEREF))
1472      o->op_ppaddr  = oi->old_pp;
1473     break;
1474 #if A_HAS_MULTIDEREF
1475    case OP_MULTIDEREF:
1476     if (o->op_ppaddr != a_pp_multideref) {
1477      oi = a_map_fetch(cUNOPo->op_first);
1478      if (!oi)
1479       break;
1480      flags = oi->flags;
1481      if (a_do_multideref(o, flags)) {
1482       a_map_store_root(o, o->op_ppaddr, flags & ~A_HINT_DEREF);
1483       o->op_ppaddr = a_pp_multideref;
1484      }
1485     }
1486     break;
1487 #endif
1488 #if !A_HAS_RPEEP
1489    case OP_MAPWHILE:
1490    case OP_GREPWHILE:
1491    case OP_AND:
1492    case OP_OR:
1493    case OP_ANDASSIGN:
1494    case OP_ORASSIGN:
1495    case OP_COND_EXPR:
1496    case OP_RANGE:
1497 # if A_HAS_PERL(5, 10, 0)
1498    case OP_ONCE:
1499    case OP_DOR:
1500    case OP_DORASSIGN:
1501 # endif
1502     a_peep_rec(cLOGOPo->op_other);
1503     break;
1504    case OP_ENTERLOOP:
1505    case OP_ENTERITER:
1506     a_peep_rec(cLOOPo->op_redoop);
1507     a_peep_rec(cLOOPo->op_nextop);
1508     a_peep_rec(cLOOPo->op_lastop);
1509     break;
1510 # if A_HAS_PERL(5, 9, 5)
1511    case OP_SUBST:
1512     a_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
1513     break;
1514 # else
1515    case OP_QR:
1516    case OP_MATCH:
1517    case OP_SUBST:
1518     a_peep_rec(cPMOPo->op_pmreplstart);
1519     break;
1520 # endif
1521 #endif /* !A_HAS_RPEEP */
1522    default:
1523     break;
1524   }
1525  }
1526 }
1527
1528 static void a_peep(pTHX_ OP *o) {
1529  ptable *seen;
1530  dMY_CXT;
1531
1532  assert(a_is_loaded(&MY_CXT));
1533
1534  MY_CXT.old_peep(aTHX_ o);
1535
1536  seen = MY_CXT.seen;
1537  if (seen) {
1538   ptable_seen_clear(seen);
1539   a_peep_rec(o);
1540   ptable_seen_clear(seen);
1541  }
1542 }
1543
1544 /* --- Module setup/teardown ----------------------------------------------- */
1545
1546 static void a_teardown(pTHX_ void *root) {
1547  dMY_CXT;
1548
1549  A_LOADED_LOCK;
1550
1551  if (a_clear_loaded_locked(&MY_CXT)) {
1552   a_ck_restore(OP_PADANY, &a_old_ck_padany);
1553   a_ck_restore(OP_PADSV,  &a_old_ck_padsv);
1554
1555   a_ck_restore(OP_AELEM,  &a_old_ck_aelem);
1556   a_ck_restore(OP_HELEM,  &a_old_ck_helem);
1557   a_ck_restore(OP_RV2SV,  &a_old_ck_rv2sv);
1558
1559   a_ck_restore(OP_RV2AV,  &a_old_ck_rv2av);
1560   a_ck_restore(OP_RV2HV,  &a_old_ck_rv2hv);
1561
1562   a_ck_restore(OP_ASLICE, &a_old_ck_aslice);
1563   a_ck_restore(OP_HSLICE, &a_old_ck_hslice);
1564
1565   a_ck_restore(OP_EXISTS, &a_old_ck_exists);
1566   a_ck_restore(OP_DELETE, &a_old_ck_delete);
1567   a_ck_restore(OP_KEYS,   &a_old_ck_keys);
1568   a_ck_restore(OP_VALUES, &a_old_ck_values);
1569
1570   ptable_map_free(a_op_map);
1571   a_op_map = NULL;
1572  }
1573
1574  A_LOADED_UNLOCK;
1575
1576  if (MY_CXT.old_peep) {
1577 #if A_HAS_RPEEP
1578   PL_rpeepp = MY_CXT.old_peep;
1579 #else
1580   PL_peepp  = MY_CXT.old_peep;
1581 #endif
1582   MY_CXT.old_peep = 0;
1583  }
1584
1585  ptable_seen_free(MY_CXT.seen);
1586  MY_CXT.seen = NULL;
1587
1588 #if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
1589  ptable_hints_free(MY_CXT.tbl);
1590  MY_CXT.tbl  = NULL;
1591 #endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
1592
1593  return;
1594 }
1595
1596 static void a_setup(pTHX) {
1597 #define a_setup() a_setup(aTHX)
1598  MY_CXT_INIT; /* Takes/release PL_my_ctx_mutex */
1599
1600  A_LOADED_LOCK;
1601
1602  if (a_set_loaded_locked(&MY_CXT)) {
1603   PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
1604
1605   a_op_map = ptable_new();
1606 #ifdef USE_ITHREADS
1607   MUTEX_INIT(&a_op_map_mutex);
1608 #endif
1609
1610   a_ck_replace(OP_PADANY, a_ck_padany, &a_old_ck_padany);
1611   a_ck_replace(OP_PADSV,  a_ck_padsv,  &a_old_ck_padsv);
1612
1613   a_ck_replace(OP_AELEM,  a_ck_deref,  &a_old_ck_aelem);
1614   a_ck_replace(OP_HELEM,  a_ck_deref,  &a_old_ck_helem);
1615   a_ck_replace(OP_RV2SV,  a_ck_deref,  &a_old_ck_rv2sv);
1616
1617   a_ck_replace(OP_RV2AV,  a_ck_rv2xv,  &a_old_ck_rv2av);
1618   a_ck_replace(OP_RV2HV,  a_ck_rv2xv,  &a_old_ck_rv2hv);
1619
1620   a_ck_replace(OP_ASLICE, a_ck_xslice, &a_old_ck_aslice);
1621   a_ck_replace(OP_HSLICE, a_ck_xslice, &a_old_ck_hslice);
1622
1623   a_ck_replace(OP_EXISTS, a_ck_root,   &a_old_ck_exists);
1624   a_ck_replace(OP_DELETE, a_ck_root,   &a_old_ck_delete);
1625   a_ck_replace(OP_KEYS,   a_ck_root,   &a_old_ck_keys);
1626   a_ck_replace(OP_VALUES, a_ck_root,   &a_old_ck_values);
1627  }
1628
1629  A_LOADED_UNLOCK;
1630
1631  {
1632   HV *stash;
1633
1634   stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
1635   newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
1636   newCONSTSUB(stash, "A_HINT_WARN",   newSVuv(A_HINT_WARN));
1637   newCONSTSUB(stash, "A_HINT_FETCH",  newSVuv(A_HINT_FETCH));
1638   newCONSTSUB(stash, "A_HINT_STORE",  newSVuv(A_HINT_STORE));
1639   newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
1640   newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
1641   newCONSTSUB(stash, "A_HINT_MASK",   newSVuv(A_HINT_MASK));
1642   newCONSTSUB(stash, "A_THREADSAFE",  newSVuv(A_THREADSAFE));
1643   newCONSTSUB(stash, "A_FORKSAFE",    newSVuv(A_FORKSAFE));
1644  }
1645
1646 #if A_HAS_RPEEP
1647  if (PL_rpeepp != a_peep) {
1648   MY_CXT.old_peep = PL_rpeepp;
1649   PL_rpeepp       = a_peep;
1650  }
1651 #else
1652  if (PL_peepp != a_peep) {
1653   MY_CXT.old_peep = PL_peepp;
1654   PL_peepp        = a_peep;
1655  }
1656 #endif
1657  else {
1658   MY_CXT.old_peep = 0;
1659  }
1660
1661  MY_CXT.seen = ptable_new();
1662
1663 #if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
1664  MY_CXT.tbl   = ptable_new();
1665  MY_CXT.owner = aTHX;
1666 #endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
1667
1668  call_atexit(a_teardown, NULL);
1669
1670  return;
1671 }
1672
1673 /* --- XS ------------------------------------------------------------------ */
1674
1675 MODULE = autovivification      PACKAGE = autovivification
1676
1677 PROTOTYPES: ENABLE
1678
1679 BOOT:
1680 {
1681  a_setup();
1682 }
1683
1684 #if A_THREADSAFE
1685
1686 void
1687 CLONE(...)
1688 PROTOTYPE: DISABLE
1689 PREINIT:
1690 #if A_WORKAROUND_REQUIRE_PROPAGATION
1691  ptable *t;
1692 #endif
1693 PPCODE:
1694 #if A_WORKAROUND_REQUIRE_PROPAGATION
1695  {
1696   a_ptable_clone_ud ud;
1697   dMY_CXT;
1698   t = ptable_new();
1699   a_ptable_clone_ud_init(ud, t, MY_CXT.owner);
1700   ptable_walk(MY_CXT.tbl, a_ptable_clone, &ud);
1701   a_ptable_clone_ud_deinit(ud);
1702  }
1703 #endif
1704  {
1705   MY_CXT_CLONE;
1706 #if A_WORKAROUND_REQUIRE_PROPAGATION
1707   MY_CXT.tbl   = t;
1708   MY_CXT.owner = aTHX;
1709 #endif
1710   MY_CXT.seen  = ptable_new();
1711   {
1712    int global_setup;
1713    A_LOADED_LOCK;
1714    global_setup = a_set_loaded_locked(&MY_CXT);
1715    assert(!global_setup);
1716    A_LOADED_UNLOCK;
1717   }
1718  }
1719  XSRETURN(0);
1720
1721 #endif /* A_THREADSAFE */
1722
1723 SV *
1724 _tag(SV *hint)
1725 PROTOTYPE: $
1726 CODE:
1727  RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
1728 OUTPUT:
1729  RETVAL
1730
1731 SV *
1732 _detag(SV *tag)
1733 PROTOTYPE: $
1734 CODE:
1735  if (!SvOK(tag))
1736   XSRETURN_UNDEF;
1737  RETVAL = newSVuv(a_detag(tag));
1738 OUTPUT:
1739  RETVAL