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 #define A_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
  25
  26 #undef ENTERn
  27 #if defined(ENTER_with_name) && !A_HAS_PERL(5, 11, 4)
  28 # define ENTERn(N) ENTER_with_name(N)
  29 #else
  30 # define ENTERn(N) ENTER
  31 #endif
  32
  33 #undef LEAVEn
  34 #if defined(LEAVE_with_name) && !A_HAS_PERL(5, 11, 4)
  35 # define LEAVEn(N) LEAVE_with_name(N)
  36 #else
  37 # define LEAVEn(N) LEAVE
  38 #endif
  39
  40 #ifndef A_WORKAROUND_REQUIRE_PROPAGATION
  41 # define A_WORKAROUND_REQUIRE_PROPAGATION !A_HAS_PERL(5, 10, 1)
  42 #endif
  43
  44 #ifndef A_HAS_RPEEP
  45 # define A_HAS_RPEEP A_HAS_PERL(5, 13, 5)
  46 #endif
  47
  48 /* ... Thread safety and multiplicity ...................................... */
  49
  50 /* Always safe when the workaround isn't needed */
  51 #if !A_WORKAROUND_REQUIRE_PROPAGATION
  52 # undef A_FORKSAFE
  53 # define A_FORKSAFE 1
  54 /* Otherwise, safe unless Makefile.PL says it's Win32 */
  55 #elif !defined(A_FORKSAFE)
  56 # define A_FORKSAFE 1
  57 #endif
  58
  59 #ifndef A_MULTIPLICITY
  60 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  61 #  define A_MULTIPLICITY 1
  62 # else
  63 #  define A_MULTIPLICITY 0
  64 # endif
  65 #endif
  66
  67 #ifndef tTHX
  68 # define tTHX PerlInterpreter*
  69 #endif
  70
  71 #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))
  72 # define A_THREADSAFE 1
  73 # ifndef MY_CXT_CLONE
  74 #  define MY_CXT_CLONE \
  75     dMY_CXT_SV;                                                      \
  76     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
  77     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
  78     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
  79 # endif
  80 #else
  81 # define A_THREADSAFE 0
  82 # undef  dMY_CXT
  83 # define dMY_CXT      dNOOP
  84 # undef  MY_CXT
  85 # define MY_CXT       a_globaldata
  86 # undef  START_MY_CXT
  87 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  88 # undef  MY_CXT_INIT
  89 # define MY_CXT_INIT  NOOP
  90 # undef  MY_CXT_CLONE
  91 # define MY_CXT_CLONE NOOP
  92 #endif
  93
  94 /* --- Helpers ------------------------------------------------------------- */
  95
  96 /* ... Thread-safe hints ................................................... */
  97
  98 #if A_WORKAROUND_REQUIRE_PROPAGATION
  99
 100 typedef struct {
 101  U32 bits;
 102  IV  require_tag;
 103 } a_hint_t;
 104
 105 #define A_HINT_FREE(H) PerlMemShared_free(H)
 106
 107 #if A_THREADSAFE
 108
 109 #define PTABLE_NAME        ptable_hints
 110 #define PTABLE_VAL_FREE(V) A_HINT_FREE(V)
 111
 112 #define pPTBL  pTHX
 113 #define pPTBL_ pTHX_
 114 #define aPTBL  aTHX
 115 #define aPTBL_ aTHX_
 116
 117 #include "ptable.h"
 118
 119 #define ptable_hints_store(T, K, V) ptable_hints_store(aTHX_ (T), (K), (V))
 120 #define ptable_hints_free(T)        ptable_hints_free(aTHX_ (T))
 121
 122 #endif /* A_THREADSAFE */
 123
 124 #endif /* A_WORKAROUND_REQUIRE_PROPAGATION */
 125
 126 #if !A_HAS_RPEEP
 127
 128 #define PTABLE_NAME        ptable_seen
 129 #define PTABLE_VAL_FREE(V) NOOP
 130
 131 #include "ptable.h"
 132
 133 #endif /* !A_HAS_RPEEP */
 134
 135 #define A_NEED_CXT ((A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION) || !A_HAS_RPEEP)
 136
 137 #if A_NEED_CXT
 138
 139 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 140
 141 typedef struct {
 142 #if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
 143  ptable *tbl;   /* It really is a ptable_hints */
 144  tTHX    owner;
 145 #endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
 146 #if !A_HAS_RPEEP
 147  ptable *seen;  /* It really is a ptable_seen */
 148 #endif /* !A_HAS_RPEEP */
 149 } my_cxt_t;
 150
 151 START_MY_CXT
 152
 153 #if A_THREADSAFE
 154
 155 #if A_WORKAROUND_REQUIRE_PROPAGATION
 156
 157 typedef struct {
 158  ptable *tbl;
 159 #if A_HAS_PERL(5, 13, 2)
 160  CLONE_PARAMS *params;
 161 #else
 162  CLONE_PARAMS params;
 163 #endif
 164 } a_ptable_clone_ud;
 165
 166 #if A_HAS_PERL(5, 13, 2)
 167 # define a_ptable_clone_ud_init(U, T, O) \
 168    (U).tbl    = (T); \
 169    (U).params = Perl_clone_params_new((O), aTHX)
 170 # define a_ptable_clone_ud_deinit(U) Perl_clone_params_del((U).params)
 171 # define a_dup_inc(S, U)             SvREFCNT_inc(sv_dup((S), (U)->params))
 172 #else
 173 # define a_ptable_clone_ud_init(U, T, O) \
 174    (U).tbl               = (T);     \
 175    (U).params.stashes    = newAV(); \
 176    (U).params.flags      = 0;       \
 177    (U).params.proto_perl = (O)
 178 # define a_ptable_clone_ud_deinit(U) SvREFCNT_dec((U).params.stashes)
 179 # define a_dup_inc(S, U)             SvREFCNT_inc(sv_dup((S), &((U)->params)))
 180 #endif
 181
 182 STATIC void a_ptable_clone(pTHX_ ptable_ent *ent, void *ud_) {
 183  a_ptable_clone_ud *ud = ud_;
 184  a_hint_t *h1 = ent->val;
 185  a_hint_t *h2;
 186
 187  h2              = PerlMemShared_malloc(sizeof *h2);
 188  h2->bits        = h1->bits;
 189  h2->require_tag = PTR2IV(a_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
 190
 191  ptable_hints_store(ud->tbl, ent->key, h2);
 192 }
 193
 194 #endif /* A_WORKAROUND_REQUIRE_PROPAGATION */
 195
 196 #include "reap.h"
 197
 198 STATIC void a_thread_cleanup(pTHX_ void *ud) {
 199  dMY_CXT;
 200
 201 #if A_WORKAROUND_REQUIRE_PROPAGATION
 202  ptable_hints_free(MY_CXT.tbl);
 203 #endif /* A_WORKAROUND_REQUIRE_PROPAGATION */
 204 #if !A_HAS_RPEEP
 205  ptable_seen_free(MY_CXT.seen);
 206 #endif /* !A_HAS_RPEEP */
 207 }
 208
 209 #endif /* A_THREADSAFE */
 210
 211 #endif /* A_NEED_CXT */
 212
 213 #if A_WORKAROUND_REQUIRE_PROPAGATION
 214
 215 STATIC IV a_require_tag(pTHX) {
 216 #define a_require_tag() a_require_tag(aTHX)
 217  const CV *cv, *outside;
 218
 219  cv = PL_compcv;
 220
 221  if (!cv) {
 222   /* If for some reason the pragma is operational at run-time, try to discover
 223    * the current cv in use. */
 224   const PERL_SI *si;
 225
 226   for (si = PL_curstackinfo; si; si = si->si_prev) {
 227    I32 cxix;
 228
 229    for (cxix = si->si_cxix; cxix >= 0; --cxix) {
 230     const PERL_CONTEXT *cx = si->si_cxstack + cxix;
 231
 232     switch (CxTYPE(cx)) {
 233      case CXt_SUB:
 234      case CXt_FORMAT:
 235       /* The propagation workaround is only needed up to 5.10.0 and at that
 236        * time format and sub contexts were still identical. And even later the
 237        * cv members offsets should have been kept the same. */
 238       cv = cx->blk_sub.cv;
 239       goto get_enclosing_cv;
 240      case CXt_EVAL:
 241       cv = cx->blk_eval.cv;
 242       goto get_enclosing_cv;
 243      default:
 244       break;
 245     }
 246    }
 247   }
 248
 249   cv = PL_main_cv;
 250  }
 251
 252 get_enclosing_cv:
 253  for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
 254   cv = outside;
 255
 256  return PTR2IV(cv);
 257 }
 258
 259 STATIC SV *a_tag(pTHX_ UV bits) {
 260 #define a_tag(B) a_tag(aTHX_ (B))
 261  a_hint_t *h;
 262 #if A_THREADSAFE
 263  dMY_CXT;
 264 #endif
 265
 266  h              = PerlMemShared_malloc(sizeof *h);
 267  h->bits        = bits;
 268  h->require_tag = a_require_tag();
 269
 270 #if A_THREADSAFE
 271  /* We only need for the key to be an unique tag for looking up the value later.
 272   * Allocated memory provides convenient unique identifiers, so that's why we
 273   * use the hint as the key itself. */
 274  ptable_hints_store(MY_CXT.tbl, h, h);
 275 #endif /* A_THREADSAFE */
 276
 277  return newSViv(PTR2IV(h));
 278 }
 279
 280 STATIC UV a_detag(pTHX_ const SV *hint) {
 281 #define a_detag(H) a_detag(aTHX_ (H))
 282  a_hint_t *h;
 283 #if A_THREADSAFE
 284  dMY_CXT;
 285 #endif
 286
 287  if (!(hint && SvIOK(hint)))
 288   return 0;
 289
 290  h = INT2PTR(a_hint_t *, SvIVX(hint));
 291 #if A_THREADSAFE
 292  h = ptable_fetch(MY_CXT.tbl, h);
 293 #endif /* A_THREADSAFE */
 294
 295  if (a_require_tag() != h->require_tag)
 296   return 0;
 297
 298  return h->bits;
 299 }
 300
 301 #else /* A_WORKAROUND_REQUIRE_PROPAGATION */
 302
 303 #define a_tag(B)   newSVuv(B)
 304 /* PVs fetched from the hints chain have their SvLEN set to zero, so get the UV
 305  * from a copy. */
 306 #define a_detag(H) \
 307  ((H)              \
 308   ? (SvIOK(H)      \
 309      ? SvUVX(H)    \
 310      : (SvPOK(H)   \
 311         ? sv_2uv(SvLEN(H) ? (H) : sv_mortalcopy(H)) \
 312         : 0        \
 313        )           \
 314      )             \
 315   : 0)
 316
 317 #endif /* !A_WORKAROUND_REQUIRE_PROPAGATION */
 318
 319 /* Used both for hints and op flags */
 320 #define A_HINT_STRICT 1
 321 #define A_HINT_WARN   2
 322 #define A_HINT_FETCH  4
 323 #define A_HINT_STORE  8
 324 #define A_HINT_EXISTS 16
 325 #define A_HINT_DELETE 32
 326 #define A_HINT_NOTIFY (A_HINT_STRICT|A_HINT_WARN)
 327 #define A_HINT_DO     (A_HINT_FETCH|A_HINT_STORE|A_HINT_EXISTS|A_HINT_DELETE)
 328 #define A_HINT_MASK   (A_HINT_NOTIFY|A_HINT_DO)
 329
 330 /* Only used in op flags */
 331 #define A_HINT_ROOT   64
 332 #define A_HINT_DEREF  128
 333
 334 STATIC U32 a_hash = 0;
 335
 336 STATIC UV a_hint(pTHX) {
 337 #define a_hint() a_hint(aTHX)
 338  SV *hint;
 339 #ifdef cop_hints_fetch_pvn
 340  hint = cop_hints_fetch_pvn(PL_curcop, __PACKAGE__, __PACKAGE_LEN__, a_hash, 0);
 341 #elif A_HAS_PERL(5, 9, 5)
 342  hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
 343                                        NULL,
 344                                        __PACKAGE__, __PACKAGE_LEN__,
 345                                        0,
 346                                        a_hash);
 347 #else
 348  SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, a_hash);
 349  if (!val)
 350   return 0;
 351  hint = *val;
 352 #endif
 353  return a_detag(hint);
 354 }
 355
 356 /* ... op => info map ...................................................... */
 357
 358 typedef struct {
 359  OP *(*old_pp)(pTHX);
 360  UV flags;
 361  void *next;
 362 } a_op_info;
 363
 364 #define PTABLE_NAME        ptable_map
 365 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
 366
 367 #include "ptable.h"
 368
 369 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
 370 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
 371
 372 STATIC ptable *a_op_map = NULL;
 373
 374 #ifdef USE_ITHREADS
 375
 376 #define dA_MAP_THX a_op_info a_op_map_tmp_oi
 377
 378 STATIC perl_mutex a_op_map_mutex;
 379
 380 #define A_LOCK(M)   MUTEX_LOCK(M)
 381 #define A_UNLOCK(M) MUTEX_UNLOCK(M)
 382
 383 STATIC const a_op_info *a_map_fetch(const OP *o, a_op_info *oi) {
 384  const a_op_info *val;
 385
 386  A_LOCK(&a_op_map_mutex);
 387
 388  val = ptable_fetch(a_op_map, o);
 389  if (val) {
 390   *oi = *val;
 391   val = oi;
 392  }
 393
 394  A_UNLOCK(&a_op_map_mutex);
 395
 396  return val;
 397 }
 398
 399 #define a_map_fetch(O) a_map_fetch((O), &a_op_map_tmp_oi)
 400
 401 #else /* USE_ITHREADS */
 402
 403 #define dA_MAP_THX dNOOP
 404
 405 #define A_LOCK(M)   NOOP
 406 #define A_UNLOCK(M) NOOP
 407
 408 #define a_map_fetch(O) ptable_fetch(a_op_map, (O))
 409
 410 #endif /* !USE_ITHREADS */
 411
 412 STATIC const a_op_info *a_map_store_locked(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), void *next, UV flags) {
 413 #define a_map_store_locked(O, PP, N, F) a_map_store_locked(aPTBLMS_ (O), (PP), (N), (F))
 414  a_op_info *oi;
 415
 416  if (!(oi = ptable_fetch(a_op_map, o))) {
 417   oi = PerlMemShared_malloc(sizeof *oi);
 418   ptable_map_store(a_op_map, o, oi);
 419  }
 420
 421  oi->old_pp = old_pp;
 422  oi->next   = next;
 423  oi->flags  = flags;
 424
 425  return oi;
 426 }
 427
 428 STATIC void a_map_store(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), void *next, UV flags) {
 429 #define a_map_store(O, PP, N, F) a_map_store(aPTBLMS_ (O), (PP), (N), (F))
 430  A_LOCK(&a_op_map_mutex);
 431
 432  a_map_store_locked(o, old_pp, next, flags);
 433
 434  A_UNLOCK(&a_op_map_mutex);
 435 }
 436
 437 STATIC void a_map_delete(pTHX_ const OP *o) {
 438 #define a_map_delete(O) a_map_delete(aTHX_ (O))
 439  A_LOCK(&a_op_map_mutex);
 440
 441  ptable_map_delete(a_op_map, o);
 442
 443  A_UNLOCK(&a_op_map_mutex);
 444 }
 445
 446 STATIC const OP *a_map_descend(const OP *o) {
 447  switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 448   case OA_BASEOP:
 449   case OA_UNOP:
 450   case OA_BINOP:
 451   case OA_BASEOP_OR_UNOP:
 452    return cUNOPo->op_first;
 453   case OA_LIST:
 454   case OA_LISTOP:
 455    return cLISTOPo->op_last;
 456  }
 457
 458  return NULL;
 459 }
 460
 461 STATIC void a_map_store_root(pPTBLMS_ const OP *root, OP *(*old_pp)(pTHX), UV flags) {
 462 #define a_map_store_root(R, PP, F) a_map_store_root(aPTBLMS_ (R), (PP), (F))
 463  const a_op_info *roi;
 464  a_op_info *oi;
 465  const OP *o = root;
 466
 467  A_LOCK(&a_op_map_mutex);
 468
 469  roi = a_map_store_locked(o, old_pp, (OP *) root, flags | A_HINT_ROOT);
 470
 471  while (o->op_flags & OPf_KIDS) {
 472   o = a_map_descend(o);
 473   if (!o)
 474    break;
 475   if ((oi = ptable_fetch(a_op_map, o))) {
 476    oi->flags &= ~A_HINT_ROOT;
 477    oi->next   = (a_op_info *) roi;
 478    break;
 479   }
 480  }
 481
 482  A_UNLOCK(&a_op_map_mutex);
 483
 484  return;
 485 }
 486
 487 STATIC void a_map_update_flags_topdown(const OP *root, UV flags) {
 488  a_op_info *oi;
 489  const OP *o = root;
 490
 491  A_LOCK(&a_op_map_mutex);
 492
 493  flags &= ~A_HINT_ROOT;
 494
 495  do {
 496   if ((oi = ptable_fetch(a_op_map, o)))
 497    oi->flags = (oi->flags & A_HINT_ROOT) | flags;
 498   if (!(o->op_flags & OPf_KIDS))
 499    break;
 500   o = a_map_descend(o);
 501  } while (o);
 502
 503  A_UNLOCK(&a_op_map_mutex);
 504
 505  return;
 506 }
 507
 508 #define a_map_cancel(R) a_map_update_flags_topdown((R), 0)
 509
 510 STATIC void a_map_update_flags_bottomup(const OP *o, UV flags, UV rflags) {
 511  a_op_info *oi;
 512
 513  A_LOCK(&a_op_map_mutex);
 514
 515  flags  &= ~A_HINT_ROOT;
 516  rflags |=  A_HINT_ROOT;
 517
 518  oi = ptable_fetch(a_op_map, o);
 519  while (!(oi->flags & A_HINT_ROOT)) {
 520   oi->flags = flags;
 521   oi        = oi->next;
 522  }
 523  oi->flags = rflags;
 524
 525  A_UNLOCK(&a_op_map_mutex);
 526
 527  return;
 528 }
 529
 530 /* ... Decide whether this expression should be autovivified or not ........ */
 531
 532 STATIC UV a_map_resolve(const OP *o, const a_op_info *oi) {
 533  UV flags = 0, rflags;
 534  const OP *root;
 535  const a_op_info *roi = oi;
 536
 537  while (!(roi->flags & A_HINT_ROOT))
 538   roi = roi->next;
 539  if (!roi)
 540   goto cancel;
 541
 542  rflags = roi->flags & ~A_HINT_ROOT;
 543  if (!rflags)
 544   goto cancel;
 545
 546  root = roi->next;
 547  if (root->op_flags & OPf_MOD) {
 548   if (rflags & A_HINT_STORE)
 549    flags = (A_HINT_STORE|A_HINT_DEREF);
 550  } else if (rflags & A_HINT_FETCH)
 551    flags = (A_HINT_FETCH|A_HINT_DEREF);
 552
 553  if (!flags) {
 554 cancel:
 555   a_map_update_flags_bottomup(o, 0, 0);
 556   return 0;
 557  }
 558
 559  flags |= (rflags & A_HINT_NOTIFY);
 560  a_map_update_flags_bottomup(o, flags, 0);
 561
 562  return oi->flags & A_HINT_ROOT ? 0 : flags;
 563 }
 564
 565 /* ... Inspired from pp_defined() .......................................... */
 566
 567 STATIC int a_undef(pTHX_ SV *sv) {
 568 #define a_undef(S) a_undef(aTHX_ (S))
 569  switch (SvTYPE(sv)) {
 570   case SVt_NULL:
 571    return 1;
 572   case SVt_PVAV:
 573    if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
 574                       || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 575     return 0;
 576    break;
 577   case SVt_PVHV:
 578    if (HvARRAY(sv) || SvGMAGICAL(sv)
 579                    || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 580     return 0;
 581    break;
 582   default:
 583    SvGETMAGIC(sv);
 584    if (SvOK(sv))
 585     return 0;
 586  }
 587
 588  return 1;
 589 }
 590
 591 /* --- PP functions -------------------------------------------------------- */
 592
 593 /* Be aware that we restore PL_op->op_ppaddr from the pointer table old_pp
 594  * value, another extension might have saved our pp replacement as the ppaddr
 595  * for this op, so this doesn't ensure that our function will never be called
 596  * again. That's why we don't remove the op info from our map, so that it can
 597  * still run correctly if required. */
 598
 599 /* ... pp_rv2av ............................................................ */
 600
 601 STATIC OP *a_pp_rv2av(pTHX) {
 602  dA_MAP_THX;
 603  const a_op_info *oi;
 604  dSP;
 605
 606  oi = a_map_fetch(PL_op);
 607
 608  if (oi->flags & A_HINT_DEREF) {
 609   if (a_undef(TOPs)) {
 610    /* We always need to push an empty array to fool the pp_aelem() that comes
 611     * later. */
 612    SV *av;
 613    POPs;
 614    av = sv_2mortal((SV *) newAV());
 615    PUSHs(av);
 616    RETURN;
 617   }
 618  } else {
 619   PL_op->op_ppaddr = oi->old_pp;
 620  }
 621
 622  return oi->old_pp(aTHX);
 623 }
 624
 625 /* ... pp_rv2hv ............................................................ */
 626
 627 STATIC OP *a_pp_rv2hv_simple(pTHX) {
 628  dA_MAP_THX;
 629  const a_op_info *oi;
 630  dSP;
 631
 632  oi = a_map_fetch(PL_op);
 633
 634  if (oi->flags & A_HINT_DEREF) {
 635   if (a_undef(TOPs))
 636    RETURN;
 637  } else {
 638   PL_op->op_ppaddr = oi->old_pp;
 639  }
 640
 641  return oi->old_pp(aTHX);
 642 }
 643
 644 STATIC OP *a_pp_rv2hv(pTHX) {
 645  dA_MAP_THX;
 646  const a_op_info *oi;
 647  dSP;
 648
 649  oi = a_map_fetch(PL_op);
 650
 651  if (oi->flags & A_HINT_DEREF) {
 652   if (a_undef(TOPs)) {
 653    SV *hv;
 654    POPs;
 655    hv = sv_2mortal((SV *) newHV());
 656    PUSHs(hv);
 657    RETURN;
 658   }
 659  } else {
 660   PL_op->op_ppaddr = oi->old_pp;
 661  }
 662
 663  return oi->old_pp(aTHX);
 664 }
 665
 666 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
 667
 668 STATIC OP *a_pp_deref(pTHX) {
 669  dA_MAP_THX;
 670  const a_op_info *oi;
 671  UV flags;
 672  dSP;
 673
 674  oi = a_map_fetch(PL_op);
 675  flags = oi->flags;
 676
 677  if (flags & A_HINT_DEREF) {
 678   OP *o;
 679   U8 old_private;
 680
 681 deref:
 682   old_private       = PL_op->op_private;
 683   PL_op->op_private = ((old_private & ~OPpDEREF) | OPpLVAL_DEFER);
 684   o = oi->old_pp(aTHX);
 685   PL_op->op_private = old_private;
 686
 687   if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
 688    SPAGAIN;
 689    if (a_undef(TOPs)) {
 690     if (flags & A_HINT_STRICT)
 691      croak("Reference vivification forbidden");
 692     else if (flags & A_HINT_WARN)
 693       warn("Reference was vivified");
 694     else /* A_HINT_STORE */
 695      croak("Can't vivify reference");
 696    }
 697   }
 698
 699   return o;
 700  } else if ((flags & ~A_HINT_ROOT)
 701                     && (PL_op->op_private & OPpDEREF || flags & A_HINT_ROOT)) {
 702   /* Decide if the expression must autovivify or not.
 703    * This branch should be called only once by expression. */
 704   flags = a_map_resolve(PL_op, oi);
 705
 706   /* We need the updated flags value in the deref branch. */
 707   if (flags & A_HINT_DEREF)
 708    goto deref;
 709  }
 710
 711  /* This op doesn't need to skip autovivification, so restore the original
 712   * state. */
 713  PL_op->op_ppaddr = oi->old_pp;
 714
 715  return oi->old_pp(aTHX);
 716 }
 717
 718 /* ... pp_root (exists,delete,keys,values) ................................. */
 719
 720 STATIC OP *a_pp_root_unop(pTHX) {
 721  dSP;
 722
 723  if (a_undef(TOPs)) {
 724   POPs;
 725   /* Can only be reached by keys or values */
 726   if (GIMME_V == G_SCALAR) {
 727    dTARGET;
 728    PUSHi(0);
 729   }
 730   RETURN;
 731  }
 732
 733  {
 734   dA_MAP_THX;
 735   const a_op_info *oi = a_map_fetch(PL_op);
 736   return oi->old_pp(aTHX);
 737  }
 738 }
 739
 740 STATIC OP *a_pp_root_binop(pTHX) {
 741  dSP;
 742
 743  if (a_undef(TOPm1s)) {
 744   POPs;
 745   POPs;
 746   if (PL_op->op_type == OP_EXISTS)
 747    RETPUSHNO;
 748   else
 749    RETPUSHUNDEF;
 750  }
 751
 752  {
 753   dA_MAP_THX;
 754   const a_op_info *oi = a_map_fetch(PL_op);
 755   return oi->old_pp(aTHX);
 756  }
 757 }
 758
 759 /* --- Check functions ----------------------------------------------------- */
 760
 761 STATIC void a_recheck_rv2xv(pTHX_ OP *o, OPCODE type, OP *(*new_pp)(pTHX)) {
 762 #define a_recheck_rv2xv(O, T, PP) a_recheck_rv2xv(aTHX_ (O), (T), (PP))
 763
 764  if (o->op_type == type && o->op_ppaddr != new_pp
 765                         && cUNOPo->op_first->op_type != OP_GV) {
 766   dA_MAP_THX;
 767   const a_op_info *oi = a_map_fetch(o);
 768   if (oi) {
 769    a_map_store(o, o->op_ppaddr, oi->next, oi->flags);
 770    o->op_ppaddr = new_pp;
 771   }
 772  }
 773
 774  return;
 775 }
 776
 777 /* ... ck_pad{any,sv} ...................................................... */
 778
 779 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
 780  * function, but are instead manually mutated from a padany. So we store
 781  * the op entry in the op map in the padany check function, and we set their
 782  * op_ppaddr member in our peephole optimizer replacement below. */
 783
 784 STATIC OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
 785
 786 STATIC OP *a_ck_padany(pTHX_ OP *o) {
 787  UV hint;
 788
 789  o = a_old_ck_padany(aTHX_ o);
 790
 791  hint = a_hint();
 792  if (hint & A_HINT_DO)
 793   a_map_store_root(o, o->op_ppaddr, hint);
 794  else
 795   a_map_delete(o);
 796
 797  return o;
 798 }
 799
 800 STATIC OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
 801
 802 STATIC OP *a_ck_padsv(pTHX_ OP *o) {
 803  UV hint;
 804
 805  o = a_old_ck_padsv(aTHX_ o);
 806
 807  hint = a_hint();
 808  if (hint & A_HINT_DO) {
 809   a_map_store_root(o, o->op_ppaddr, hint);
 810   o->op_ppaddr = a_pp_deref;
 811  } else
 812   a_map_delete(o);
 813
 814  return o;
 815 }
 816
 817 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
 818
 819 /* Those ops appear both at the root and inside an expression but there's no
 820  * way to distinguish both situations. Worse, we can't even know if we are in a
 821  * modifying context, so the expression can't be resolved yet. It will be at the
 822  * first invocation of a_pp_deref() for this expression. */
 823
 824 STATIC OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
 825 STATIC OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
 826 STATIC OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
 827
 828 STATIC OP *a_ck_deref(pTHX_ OP *o) {
 829  OP * (*old_ck)(pTHX_ OP *o) = 0;
 830  UV hint = a_hint();
 831
 832  switch (o->op_type) {
 833   case OP_AELEM:
 834    old_ck = a_old_ck_aelem;
 835    if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT))
 836     a_recheck_rv2xv(cUNOPo->op_first, OP_RV2AV, a_pp_rv2av);
 837    break;
 838   case OP_HELEM:
 839    old_ck = a_old_ck_helem;
 840    if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT))
 841     a_recheck_rv2xv(cUNOPo->op_first, OP_RV2HV, a_pp_rv2hv_simple);
 842    break;
 843   case OP_RV2SV:
 844    old_ck = a_old_ck_rv2sv;
 845    break;
 846  }
 847  o = old_ck(aTHX_ o);
 848
 849  if (hint & A_HINT_DO) {
 850   a_map_store_root(o, o->op_ppaddr, hint);
 851   o->op_ppaddr = a_pp_deref;
 852  } else
 853   a_map_delete(o);
 854
 855  return o;
 856 }
 857
 858 /* ... ck_rv2xv (rv2av,rv2hv) .............................................. */
 859
 860 /* Those ops also appear both inisde and at the root, hence the caveats for
 861  * a_ck_deref() still apply here. Since a padsv/rv2sv must appear before a
 862  * rv2[ah]v, resolution is handled by the first call to a_pp_deref() in the
 863  * expression. */
 864
 865 STATIC OP *(*a_old_ck_rv2av)(pTHX_ OP *) = 0;
 866 STATIC OP *(*a_old_ck_rv2hv)(pTHX_ OP *) = 0;
 867
 868 STATIC OP *a_ck_rv2xv(pTHX_ OP *o) {
 869  OP * (*old_ck)(pTHX_ OP *o) = 0;
 870  OP * (*new_pp)(pTHX)        = 0;
 871  UV hint;
 872
 873  switch (o->op_type) {
 874   case OP_RV2AV: old_ck = a_old_ck_rv2av; new_pp = a_pp_rv2av; break;
 875   case OP_RV2HV: old_ck = a_old_ck_rv2hv; new_pp = a_pp_rv2hv_simple; break;
 876  }
 877  o = old_ck(aTHX_ o);
 878
 879  if (cUNOPo->op_first->op_type == OP_GV)
 880   return o;
 881
 882  hint = a_hint();
 883  if (hint & A_HINT_DO && !(hint & A_HINT_STRICT)) {
 884   a_map_store_root(o, o->op_ppaddr, hint);
 885   o->op_ppaddr = new_pp;
 886  } else
 887   a_map_delete(o);
 888
 889  return o;
 890 }
 891
 892 /* ... ck_xslice (aslice,hslice) ........................................... */
 893
 894 /* I think those are only found at the root, but there's nothing that really
 895  * prevent them to be inside the expression too. We only need to update the
 896  * root so that the rest of the expression will see the right context when
 897  * resolving. That's why we don't replace the ppaddr. */
 898
 899 STATIC OP *(*a_old_ck_aslice)(pTHX_ OP *) = 0;
 900 STATIC OP *(*a_old_ck_hslice)(pTHX_ OP *) = 0;
 901
 902 STATIC OP *a_ck_xslice(pTHX_ OP *o) {
 903  OP * (*old_ck)(pTHX_ OP *o) = 0;
 904  UV hint = a_hint();
 905
 906  switch (o->op_type) {
 907   case OP_ASLICE:
 908    old_ck = a_old_ck_aslice;
 909    break;
 910   case OP_HSLICE:
 911    old_ck = a_old_ck_hslice;
 912    if (hint & A_HINT_DO)
 913     a_recheck_rv2xv(cUNOPo->op_first->op_sibling, OP_RV2HV, a_pp_rv2hv);
 914    break;
 915  }
 916  o = old_ck(aTHX_ o);
 917
 918  if (hint & A_HINT_DO) {
 919   a_map_store_root(o, 0, hint);
 920  } else
 921   a_map_delete(o);
 922
 923  return o;
 924 }
 925
 926 /* ... ck_root (exists,delete,keys,values) ................................. */
 927
 928 /* Those ops are only found at the root of a dereferencing expression. We can
 929  * then resolve at compile time if vivification must take place or not. */
 930
 931 STATIC OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
 932 STATIC OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
 933 STATIC OP *(*a_old_ck_keys)  (pTHX_ OP *) = 0;
 934 STATIC OP *(*a_old_ck_values)(pTHX_ OP *) = 0;
 935
 936 STATIC OP *a_ck_root(pTHX_ OP *o) {
 937  OP * (*old_ck)(pTHX_ OP *o) = 0;
 938  OP * (*new_pp)(pTHX)        = 0;
 939  bool enabled = FALSE;
 940  UV hint = a_hint();
 941
 942  switch (o->op_type) {
 943   case OP_EXISTS:
 944    old_ck  = a_old_ck_exists;
 945    new_pp  = a_pp_root_binop;
 946    enabled = hint & A_HINT_EXISTS;
 947    break;
 948   case OP_DELETE:
 949    old_ck  = a_old_ck_delete;
 950    new_pp  = a_pp_root_binop;
 951    enabled = hint & A_HINT_DELETE;
 952    break;
 953   case OP_KEYS:
 954    old_ck  = a_old_ck_keys;
 955    new_pp  = a_pp_root_unop;
 956    enabled = hint & A_HINT_FETCH;
 957    break;
 958   case OP_VALUES:
 959    old_ck  = a_old_ck_values;
 960    new_pp  = a_pp_root_unop;
 961    enabled = hint & A_HINT_FETCH;
 962    break;
 963  }
 964  o = old_ck(aTHX_ o);
 965
 966  if (hint & A_HINT_DO) {
 967   if (enabled) {
 968    a_map_update_flags_topdown(o, hint | A_HINT_DEREF);
 969    a_map_store_root(o, o->op_ppaddr, hint);
 970    o->op_ppaddr = new_pp;
 971   } else {
 972    a_map_cancel(o);
 973   }
 974  } else
 975   a_map_delete(o);
 976
 977  return o;
 978 }
 979
 980 /* ... Our peephole optimizer .............................................. */
 981
 982 STATIC peep_t a_old_peep = 0; /* This is actually the rpeep past 5.13.5 */
 983
 984 #if !A_HAS_RPEEP
 985 # define A_PEEP_REC_PROTO STATIC void a_peep_rec(pTHX_ OP *o, ptable *seen)
 986 #else /* !A_HAS_RPEEP */
 987 # define A_PEEP_REC_PROTO STATIC void a_peep_rec(pTHX_ OP *o)
 988 #endif /* A_HAS_RPEEP */
 989
 990 A_PEEP_REC_PROTO;
 991 A_PEEP_REC_PROTO {
 992 #if !A_HAS_RPEEP
 993 # define a_peep_rec(O) a_peep_rec(aTHX_ (O), seen)
 994 #else /* !A_HAS_RPEEP */
 995 # define a_peep_rec(O) a_peep_rec(aTHX_ (O))
 996 #endif /* A_HAS_RPEEP */
 997  dA_MAP_THX;
 998  const a_op_info *oi;
 999
1000 #if !A_HAS_RPEEP
1001  if (ptable_fetch(seen, o))
1002   return;
1003 #endif
1004
1005  for (; o; o = o->op_next) {
1006 #if !A_HAS_RPEEP
1007   ptable_seen_store(seen, o, o);
1008 #endif
1009   switch (o->op_type) {
1010    case OP_PADSV:
1011     if (o->op_ppaddr != a_pp_deref) {
1012      oi = a_map_fetch(o);
1013      if (oi && (oi->flags & A_HINT_DO)) {
1014       a_map_store(o, o->op_ppaddr, oi->next, oi->flags);
1015       o->op_ppaddr = a_pp_deref;
1016      }
1017     }
1018     break;
1019 #if !A_HAS_RPEEP
1020    case OP_MAPWHILE:
1021    case OP_GREPWHILE:
1022    case OP_AND:
1023    case OP_OR:
1024    case OP_ANDASSIGN:
1025    case OP_ORASSIGN:
1026    case OP_COND_EXPR:
1027    case OP_RANGE:
1028 # if A_HAS_PERL(5, 10, 0)
1029    case OP_ONCE:
1030    case OP_DOR:
1031    case OP_DORASSIGN:
1032 # endif
1033     a_peep_rec(cLOGOPo->op_other);
1034     break;
1035    case OP_ENTERLOOP:
1036    case OP_ENTERITER:
1037     a_peep_rec(cLOOPo->op_redoop);
1038     a_peep_rec(cLOOPo->op_nextop);
1039     a_peep_rec(cLOOPo->op_lastop);
1040     break;
1041 # if A_HAS_PERL(5, 9, 5)
1042    case OP_SUBST:
1043     a_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
1044     break;
1045 # else
1046    case OP_QR:
1047    case OP_MATCH:
1048    case OP_SUBST:
1049     a_peep_rec(cPMOPo->op_pmreplstart);
1050     break;
1051 # endif
1052 #endif /* !A_HAS_RPEEP */
1053    default:
1054     break;
1055   }
1056  }
1057 }
1058
1059 STATIC void a_peep(pTHX_ OP *o) {
1060 #if !A_HAS_RPEEP
1061  dMY_CXT;
1062  ptable *seen = MY_CXT.seen;
1063
1064  ptable_seen_clear(seen);
1065 #endif /* !A_HAS_RPEEP */
1066
1067 #if A_HAS_PERL_EXACT(5, 8, 2)
1068  /* 5.8.2's peephole optimizer has a naughty bug with stub ops coming from
1069   * sub { }. */
1070  a_peep_rec(o);
1071  a_old_peep(aTHX_ o);
1072 #else
1073  a_old_peep(aTHX_ o);
1074  a_peep_rec(o);
1075 #endif
1076 }
1077
1078 /* --- Interpreter setup/teardown ------------------------------------------ */
1079
1080 STATIC U32 a_initialized = 0;
1081
1082 STATIC void a_teardown(pTHX_ void *root) {
1083
1084  if (!a_initialized)
1085   return;
1086
1087 #if A_MULTIPLICITY
1088  if (aTHX != root)
1089   return;
1090 #endif
1091
1092 #if A_NEED_CXT
1093  {
1094   dMY_CXT;
1095 # if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
1096   ptable_hints_free(MY_CXT.tbl);
1097 # endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
1098 # if !A_HAS_RPEEP
1099   ptable_seen_free(MY_CXT.seen);
1100 # endif /* !A_HAS_RPEEP */
1101  }
1102 #endif /* A_NEED_CXT */
1103
1104  PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_old_ck_padany);
1105  a_old_ck_padany     = 0;
1106  PL_check[OP_PADSV]  = MEMBER_TO_FPTR(a_old_ck_padsv);
1107  a_old_ck_padsv      = 0;
1108
1109  PL_check[OP_AELEM]  = MEMBER_TO_FPTR(a_old_ck_aelem);
1110  a_old_ck_aelem      = 0;
1111  PL_check[OP_HELEM]  = MEMBER_TO_FPTR(a_old_ck_helem);
1112  a_old_ck_helem      = 0;
1113  PL_check[OP_RV2SV]  = MEMBER_TO_FPTR(a_old_ck_rv2sv);
1114  a_old_ck_rv2sv      = 0;
1115
1116  PL_check[OP_RV2AV]  = MEMBER_TO_FPTR(a_old_ck_rv2av);
1117  a_old_ck_rv2av      = 0;
1118  PL_check[OP_RV2HV]  = MEMBER_TO_FPTR(a_old_ck_rv2hv);
1119  a_old_ck_rv2hv      = 0;
1120
1121  PL_check[OP_ASLICE] = MEMBER_TO_FPTR(a_old_ck_aslice);
1122  a_old_ck_aslice     = 0;
1123  PL_check[OP_HSLICE] = MEMBER_TO_FPTR(a_old_ck_hslice);
1124  a_old_ck_hslice     = 0;
1125
1126  PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_old_ck_exists);
1127  a_old_ck_exists     = 0;
1128  PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_old_ck_delete);
1129  a_old_ck_delete     = 0;
1130  PL_check[OP_KEYS]   = MEMBER_TO_FPTR(a_old_ck_keys);
1131  a_old_ck_keys       = 0;
1132  PL_check[OP_VALUES] = MEMBER_TO_FPTR(a_old_ck_values);
1133  a_old_ck_values     = 0;
1134
1135 #if A_HAS_RPEEP
1136  PL_rpeepp  = a_old_peep;
1137 #else
1138  PL_peepp   = a_old_peep;
1139 #endif
1140  a_old_peep = 0;
1141
1142  a_initialized = 0;
1143 }
1144
1145 STATIC void a_setup(pTHX) {
1146 #define a_setup() a_setup(aTHX)
1147  if (a_initialized)
1148   return;
1149
1150 #if A_NEED_CXT
1151  {
1152   MY_CXT_INIT;
1153 # if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
1154   MY_CXT.tbl   = ptable_new();
1155   MY_CXT.owner = aTHX;
1156 # endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
1157 # if !A_HAS_RPEEP
1158   MY_CXT.seen  = ptable_new();
1159 # endif /* !A_RPEEP */
1160  }
1161 #endif /* A_NEED_CXT */
1162
1163  a_old_ck_padany     = PL_check[OP_PADANY];
1164  PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_ck_padany);
1165  a_old_ck_padsv      = PL_check[OP_PADSV];
1166  PL_check[OP_PADSV]  = MEMBER_TO_FPTR(a_ck_padsv);
1167
1168  a_old_ck_aelem      = PL_check[OP_AELEM];
1169  PL_check[OP_AELEM]  = MEMBER_TO_FPTR(a_ck_deref);
1170  a_old_ck_helem      = PL_check[OP_HELEM];
1171  PL_check[OP_HELEM]  = MEMBER_TO_FPTR(a_ck_deref);
1172  a_old_ck_rv2sv      = PL_check[OP_RV2SV];
1173  PL_check[OP_RV2SV]  = MEMBER_TO_FPTR(a_ck_deref);
1174
1175  a_old_ck_rv2av      = PL_check[OP_RV2AV];
1176  PL_check[OP_RV2AV]  = MEMBER_TO_FPTR(a_ck_rv2xv);
1177  a_old_ck_rv2hv      = PL_check[OP_RV2HV];
1178  PL_check[OP_RV2HV]  = MEMBER_TO_FPTR(a_ck_rv2xv);
1179
1180  a_old_ck_aslice     = PL_check[OP_ASLICE];
1181  PL_check[OP_ASLICE] = MEMBER_TO_FPTR(a_ck_xslice);
1182  a_old_ck_hslice     = PL_check[OP_HSLICE];
1183  PL_check[OP_HSLICE] = MEMBER_TO_FPTR(a_ck_xslice);
1184
1185  a_old_ck_exists     = PL_check[OP_EXISTS];
1186  PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_ck_root);
1187  a_old_ck_delete     = PL_check[OP_DELETE];
1188  PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_ck_root);
1189  a_old_ck_keys       = PL_check[OP_KEYS];
1190  PL_check[OP_KEYS]   = MEMBER_TO_FPTR(a_ck_root);
1191  a_old_ck_values     = PL_check[OP_VALUES];
1192  PL_check[OP_VALUES] = MEMBER_TO_FPTR(a_ck_root);
1193
1194 #if A_HAS_RPEEP
1195  a_old_peep = PL_rpeepp;
1196  PL_rpeepp  = a_peep;
1197 #else
1198  a_old_peep = PL_peepp;
1199  PL_peepp   = a_peep;
1200 #endif
1201
1202 #if A_MULTIPLICITY
1203  call_atexit(a_teardown, aTHX);
1204 #else
1205  call_atexit(a_teardown, NULL);
1206 #endif
1207
1208  a_initialized = 1;
1209 }
1210
1211 STATIC U32 a_booted = 0;
1212
1213 /* --- XS ------------------------------------------------------------------ */
1214
1215 MODULE = autovivification      PACKAGE = autovivification
1216
1217 PROTOTYPES: ENABLE
1218
1219 BOOT:
1220 {
1221  if (!a_booted++) {
1222   HV *stash;
1223
1224   a_op_map = ptable_new();
1225 #ifdef USE_ITHREADS
1226   MUTEX_INIT(&a_op_map_mutex);
1227 #endif
1228
1229   PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
1230
1231   stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
1232   newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
1233   newCONSTSUB(stash, "A_HINT_WARN",   newSVuv(A_HINT_WARN));
1234   newCONSTSUB(stash, "A_HINT_FETCH",  newSVuv(A_HINT_FETCH));
1235   newCONSTSUB(stash, "A_HINT_STORE",  newSVuv(A_HINT_STORE));
1236   newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
1237   newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
1238   newCONSTSUB(stash, "A_HINT_MASK",   newSVuv(A_HINT_MASK));
1239   newCONSTSUB(stash, "A_THREADSAFE",  newSVuv(A_THREADSAFE));
1240   newCONSTSUB(stash, "A_FORKSAFE",    newSVuv(A_FORKSAFE));
1241  }
1242
1243  a_setup();
1244 }
1245
1246 #if A_THREADSAFE && (A_WORKAROUND_REQUIRE_PROPAGATION || !A_HAS_RPEEP)
1247
1248 void
1249 CLONE(...)
1250 PROTOTYPE: DISABLE
1251 PREINIT:
1252 #if A_WORKAROUND_REQUIRE_PROPAGATION
1253  ptable *t;
1254 #endif
1255 #if !A_HAS_RPEEP
1256  ptable *s;
1257 #endif
1258 PPCODE:
1259  {
1260   dMY_CXT;
1261 #if A_WORKAROUND_REQUIRE_PROPAGATION
1262   {
1263    a_ptable_clone_ud ud;
1264
1265    t = ptable_new();
1266    a_ptable_clone_ud_init(ud, t, MY_CXT.owner);
1267    ptable_walk(MY_CXT.tbl, a_ptable_clone, &ud);
1268    a_ptable_clone_ud_deinit(ud);
1269   }
1270 #endif
1271 #if !A_HAS_RPEEP
1272   s = ptable_new();
1273 #endif
1274  }
1275  {
1276   MY_CXT_CLONE;
1277 #if A_WORKAROUND_REQUIRE_PROPAGATION
1278   MY_CXT.tbl   = t;
1279   MY_CXT.owner = aTHX;
1280 #endif
1281 #if !A_HAS_RPEEP
1282   MY_CXT.seen  = s;
1283 #endif
1284  }
1285  reap(3, a_thread_cleanup, NULL);
1286  XSRETURN(0);
1287
1288 #endif
1289
1290 SV *
1291 _tag(SV *hint)
1292 PROTOTYPE: $
1293 CODE:
1294  RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
1295 OUTPUT:
1296  RETVAL
1297
1298 SV *
1299 _detag(SV *tag)
1300 PROTOTYPE: $
1301 CODE:
1302  if (!SvOK(tag))
1303   XSRETURN_UNDEF;
1304  RETVAL = newSVuv(a_detag(tag));
1305 OUTPUT:
1306  RETVAL