1 /* This file is part of the autovivification Perl module.
2 * See http://search.cpan.org/dist/autovivification/ */
4 #define PERL_NO_GET_CONTEXT
9 #define __PACKAGE__ "autovivification"
10 #define __PACKAGE_LEN__ (sizeof(__PACKAGE__)-1)
12 /* --- Compatibility wrappers ---------------------------------------------- */
15 # define HvNAME_get(H) HvNAME(H)
19 # define HvNAMELEN_get(H) strlen(HvNAME_get(H))
22 #define A_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
24 #ifndef A_WORKAROUND_REQUIRE_PROPAGATION
25 # define A_WORKAROUND_REQUIRE_PROPAGATION !A_HAS_PERL(5, 10, 1)
29 # define A_HAS_RPEEP A_HAS_PERL(5, 13, 5)
32 #ifndef A_HAS_MULTIDEREF
33 # define A_HAS_MULTIDEREF A_HAS_PERL(5, 21, 7)
38 # define OpSIBLING(O) OP_SIBLING(O)
40 # define OpSIBLING(O) ((O)->op_sibling)
44 /* ... Thread safety and multiplicity ...................................... */
46 /* Always safe when the workaround isn't needed */
47 #if !A_WORKAROUND_REQUIRE_PROPAGATION
50 /* Otherwise, safe unless Makefile.PL says it's Win32 */
51 #elif !defined(A_FORKSAFE)
55 #ifndef A_MULTIPLICITY
56 # if defined(MULTIPLICITY)
57 # define A_MULTIPLICITY 1
59 # define A_MULTIPLICITY 0
63 # ifndef PERL_IMPLICIT_CONTEXT
64 # error MULTIPLICITY builds must set PERL_IMPLICIT_CONTEXT
69 # define tTHX PerlInterpreter*
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
75 # define MY_CXT_CLONE \
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))
82 # define A_THREADSAFE 0
84 # define dMY_CXT dNOOP
86 # define MY_CXT a_globaldata
88 # define START_MY_CXT static my_cxt_t MY_CXT;
90 # define MY_CXT_INIT NOOP
92 # define MY_CXT_CLONE NOOP
96 /* We must use preexistent global mutexes or we will never be able to destroy
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)
102 # define A_LOADED_LOCK OP_REFCNT_LOCK
103 # define A_LOADED_UNLOCK OP_REFCNT_UNLOCK
106 # define A_LOADED_LOCK NOOP
107 # define A_LOADED_UNLOCK NOOP
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
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
120 # define A_CHECK_LOCK NOOP
121 # define A_CHECK_UNLOCK NOOP
124 typedef OP *(*a_ck_t)(pTHX_ OP *);
126 #ifdef wrap_op_checker
128 # define a_ck_replace(T, NC, OCP) wrap_op_checker((T), (NC), (OCP))
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))
136 *old_ck_p = PL_check[type];
137 PL_check[type] = new_ck;
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))
148 PL_check[type] = *old_ck_p;
154 /* --- Helpers ------------------------------------------------------------- */
156 /* ... Check if the module is loaded ....................................... */
158 static I32 a_loaded = 0;
162 #define PTABLE_NAME ptable_loaded
163 #define PTABLE_NEED_DELETE 1
164 #define PTABLE_NEED_WALK 0
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))
172 static ptable *a_loaded_cxts = NULL;
174 static int a_is_loaded(pTHX_ void *cxt) {
175 #define a_is_loaded(C) a_is_loaded(aTHX_ (C))
179 if (a_loaded_cxts && ptable_fetch(a_loaded_cxts, cxt))
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;
191 assert(a_loaded == 0);
192 assert(!a_loaded_cxts);
193 a_loaded_cxts = ptable_new();
197 assert(a_loaded_cxts);
198 ptable_loaded_store(a_loaded_cxts, cxt, cxt);
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;
208 assert(a_loaded_cxts);
209 ptable_loaded_delete(a_loaded_cxts, cxt);
211 } else if (a_loaded_cxts) {
212 assert(a_loaded == 1);
213 ptable_loaded_free(a_loaded_cxts);
214 a_loaded_cxts = NULL;
219 return global_teardown;
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)
230 /* ... Thread-safe hints ................................................... */
232 #if A_WORKAROUND_REQUIRE_PROPAGATION
239 #define A_HINT_FREE(H) PerlMemShared_free(H)
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
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))
258 #endif /* A_THREADSAFE */
260 #endif /* A_WORKAROUND_REQUIRE_PROPAGATION */
262 #define PTABLE_NAME ptable_seen
263 #define PTABLE_NEED_DELETE 0
264 #define PTABLE_NEED_WALK 0
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))
273 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
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 */
281 #endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
286 #if A_WORKAROUND_REQUIRE_PROPAGATION
292 #if A_HAS_PERL(5, 13, 2)
293 CLONE_PARAMS *params;
299 #if A_HAS_PERL(5, 13, 2)
300 # define a_ptable_clone_ud_init(U, T, O) \
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))
306 # define a_ptable_clone_ud_init(U, T, O) \
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)))
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;
320 h2 = PerlMemShared_malloc(sizeof *h2);
322 h2->require_tag = PTR2IV(a_dup_inc(INT2PTR(SV *, h1->require_tag), ud));
324 ptable_hints_store(ud->tbl, ent->key, h2);
327 #endif /* A_THREADSAFE */
329 static IV a_require_tag(pTHX) {
330 #define a_require_tag() a_require_tag(aTHX)
331 const CV *cv, *outside;
336 /* If for some reason the pragma is operational at run-time, try to discover
337 * the current cv in use. */
340 for (si = PL_curstackinfo; si; si = si->si_prev) {
343 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
344 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
346 switch (CxTYPE(cx)) {
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. */
353 goto get_enclosing_cv;
355 cv = cx->blk_eval.cv;
356 goto get_enclosing_cv;
367 for (outside = CvOUTSIDE(cv); outside; outside = CvOUTSIDE(cv))
373 static SV *a_tag(pTHX_ UV bits) {
374 #define a_tag(B) a_tag(aTHX_ (B))
381 #endif /* A_THREADSAFE */
383 h = PerlMemShared_malloc(sizeof *h);
385 h->require_tag = a_require_tag();
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 */
394 return newSViv(PTR2IV(h));
397 static UV a_detag(pTHX_ const SV *hint) {
398 #define a_detag(H) a_detag(aTHX_ (H))
405 #endif /* A_THREADSAFE */
407 if (!(hint && SvIOK(hint)))
410 h = INT2PTR(a_hint_t *, SvIVX(hint));
412 h = ptable_fetch(MY_CXT.tbl, h);
413 #endif /* A_THREADSAFE */
415 if (a_require_tag() != h->require_tag)
421 #else /* A_WORKAROUND_REQUIRE_PROPAGATION */
423 #define a_tag(B) newSVuv(B)
424 /* PVs fetched from the hints chain have their SvLEN set to zero, so get the UV
431 ? sv_2uv(SvLEN(H) ? (H) : sv_mortalcopy(H)) \
437 #endif /* !A_WORKAROUND_REQUIRE_PROPAGATION */
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)
450 /* Only used in op flags */
451 #define A_HINT_ROOT 64
452 #define A_HINT_DEREF 128
454 static VOL U32 a_hash = 0;
456 static UV a_hint(pTHX) {
457 #define a_hint() a_hint(aTHX)
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,
464 __PACKAGE__, __PACKAGE_LEN__,
468 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, 0);
473 return a_detag(hint);
476 /* ... op => info map ...................................................... */
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
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 #define ptable_map_free(T) ptable_map_free(aPTBLMS_ (T))
496 static ptable *a_op_map = NULL;
500 #define dA_MAP_THX a_op_info a_op_map_tmp_oi
502 static perl_mutex a_op_map_mutex;
504 #define A_LOCK(M) MUTEX_LOCK(M)
505 #define A_UNLOCK(M) MUTEX_UNLOCK(M)
507 static const a_op_info *a_map_fetch(const OP *o, a_op_info *oi) {
508 const a_op_info *val;
510 A_LOCK(&a_op_map_mutex);
512 val = ptable_fetch(a_op_map, o);
518 A_UNLOCK(&a_op_map_mutex);
523 #define a_map_fetch(O) a_map_fetch((O), &a_op_map_tmp_oi)
525 #else /* USE_ITHREADS */
527 #define dA_MAP_THX dNOOP
529 #define A_LOCK(M) NOOP
530 #define A_UNLOCK(M) NOOP
532 #define a_map_fetch(O) ptable_fetch(a_op_map, (O))
534 #endif /* !USE_ITHREADS */
536 static const a_op_info *a_map_store_locked(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), void *next, UV flags) {
537 #define a_map_store_locked(O, PP, N, F) a_map_store_locked(aPTBLMS_ (O), (PP), (N), (F))
540 if (!(oi = ptable_fetch(a_op_map, o))) {
541 oi = PerlMemShared_malloc(sizeof *oi);
542 ptable_map_store(a_op_map, o, oi);
552 static void a_map_store(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), void *next, UV flags) {
553 #define a_map_store(O, PP, N, F) a_map_store(aPTBLMS_ (O), (PP), (N), (F))
554 A_LOCK(&a_op_map_mutex);
556 a_map_store_locked(o, old_pp, next, flags);
558 A_UNLOCK(&a_op_map_mutex);
561 static void a_map_delete(pTHX_ const OP *o) {
562 #define a_map_delete(O) a_map_delete(aTHX_ (O))
563 A_LOCK(&a_op_map_mutex);
565 ptable_map_delete(a_op_map, o);
567 A_UNLOCK(&a_op_map_mutex);
570 static const OP *a_map_descend(const OP *o) {
571 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
575 case OA_BASEOP_OR_UNOP:
576 return cUNOPo->op_first;
579 return cLISTOPo->op_last;
585 static void a_map_store_root(pPTBLMS_ const OP *root, OP *(*old_pp)(pTHX), UV flags) {
586 #define a_map_store_root(R, PP, F) a_map_store_root(aPTBLMS_ (R), (PP), (F))
587 const a_op_info *roi;
591 A_LOCK(&a_op_map_mutex);
593 roi = a_map_store_locked(o, old_pp, (OP *) root, flags | A_HINT_ROOT);
595 while (o->op_flags & OPf_KIDS) {
596 o = a_map_descend(o);
599 if ((oi = ptable_fetch(a_op_map, o))) {
600 oi->flags &= ~A_HINT_ROOT;
601 oi->next = (a_op_info *) roi;
606 A_UNLOCK(&a_op_map_mutex);
611 static void a_map_update_flags_topdown(const OP *root, UV flags) {
615 A_LOCK(&a_op_map_mutex);
617 flags &= ~A_HINT_ROOT;
620 if ((oi = ptable_fetch(a_op_map, o)))
621 oi->flags = (oi->flags & A_HINT_ROOT) | flags;
622 if (!(o->op_flags & OPf_KIDS))
624 o = a_map_descend(o);
627 A_UNLOCK(&a_op_map_mutex);
632 #define a_map_cancel(R) a_map_update_flags_topdown((R), 0)
634 static void a_map_update_flags_bottomup(const OP *o, UV flags, UV rflags) {
637 A_LOCK(&a_op_map_mutex);
639 flags &= ~A_HINT_ROOT;
640 rflags |= A_HINT_ROOT;
642 oi = ptable_fetch(a_op_map, o);
643 while (!(oi->flags & A_HINT_ROOT)) {
649 A_UNLOCK(&a_op_map_mutex);
654 /* ... Decide whether this expression should be autovivified or not ........ */
656 static UV a_map_resolve(const OP *o, const a_op_info *oi) {
657 UV flags = 0, rflags;
659 const a_op_info *roi = oi;
661 while (!(roi->flags & A_HINT_ROOT))
666 rflags = roi->flags & ~A_HINT_ROOT;
671 if (root->op_flags & OPf_MOD) {
672 if (rflags & A_HINT_STORE)
673 flags = (A_HINT_STORE|A_HINT_DEREF);
674 } else if (rflags & A_HINT_FETCH)
675 flags = (A_HINT_FETCH|A_HINT_DEREF);
679 a_map_update_flags_bottomup(o, 0, 0);
683 flags |= (rflags & A_HINT_NOTIFY);
684 a_map_update_flags_bottomup(o, flags, 0);
686 return oi->flags & A_HINT_ROOT ? 0 : flags;
689 /* ... Inspired from pp_defined() .......................................... */
691 static int a_undef(pTHX_ SV *sv) {
692 #define a_undef(S) a_undef(aTHX_ (S))
693 switch (SvTYPE(sv)) {
697 if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
698 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
702 if (HvARRAY(sv) || SvGMAGICAL(sv)
703 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
715 /* --- PP functions -------------------------------------------------------- */
717 /* Be aware that we restore PL_op->op_ppaddr from the pointer table old_pp
718 * value, another extension might have saved our pp replacement as the ppaddr
719 * for this op, so this doesn't ensure that our function will never be called
720 * again. That's why we don't remove the op info from our map, so that it can
721 * still run correctly if required. */
723 /* ... pp_rv2av ............................................................ */
725 static OP *a_pp_rv2av(pTHX) {
730 oi = a_map_fetch(PL_op);
732 if (oi->flags & A_HINT_DEREF) {
734 /* We always need to push an empty array to fool the pp_aelem() that comes
738 av = sv_2mortal((SV *) newAV());
744 return oi->old_pp(aTHX);
747 /* ... pp_rv2hv ............................................................ */
749 static OP *a_pp_rv2hv_simple(pTHX) {
754 oi = a_map_fetch(PL_op);
756 if (oi->flags & A_HINT_DEREF) {
761 return oi->old_pp(aTHX);
764 static OP *a_pp_rv2hv(pTHX) {
769 oi = a_map_fetch(PL_op);
771 if (oi->flags & A_HINT_DEREF) {
775 hv = sv_2mortal((SV *) newHV());
781 return oi->old_pp(aTHX);
784 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
786 static void a_cannot_vivify(pTHX_ UV flags) {
787 #define a_cannot_vivify(F) a_cannot_vivify(aTHX_ (F))
788 if (flags & A_HINT_STRICT)
789 croak("Reference vivification forbidden");
790 else if (flags & A_HINT_WARN)
791 warn("Reference was vivified");
792 else /* A_HINT_STORE */
793 croak("Can't vivify reference");
796 static OP *a_pp_deref(pTHX) {
802 oi = a_map_fetch(PL_op);
805 if (flags & A_HINT_DEREF) {
808 o = oi->old_pp(aTHX);
810 if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
813 a_cannot_vivify(flags);
819 return oi->old_pp(aTHX);
822 /* ... pp_root (exists,delete,keys,values) ................................. */
824 static OP *a_pp_root_unop(pTHX) {
829 /* Can only be reached by keys or values */
830 if (GIMME_V == G_SCALAR) {
839 const a_op_info *oi = a_map_fetch(PL_op);
840 return oi->old_pp(aTHX);
844 static OP *a_pp_root_binop(pTHX) {
847 if (a_undef(TOPm1s)) {
850 if (PL_op->op_type == OP_EXISTS)
858 const a_op_info *oi = a_map_fetch(PL_op);
859 return oi->old_pp(aTHX);
865 /* ... pp_multideref ....................................................... */
867 /* This pp replacement is actually only called for topmost exists/delete ops,
868 * because we hijack the [ah]elem check functions and this disables the
869 * optimization for lvalue and rvalue dereferencing. In particular, the
870 * OPf_MOD branches should never be covered. In the future, the multideref
871 * optimization might also be disabled for custom exists/delete check functions,
872 * which will make this section unnecessary. However, the code tries to be as
873 * general as possible in case I think of a way to reenable the multideref
874 * optimization even when this module is in use. */
876 static UV a_do_multideref(const OP *o, UV flags) {
877 UV isexdel, other_flags;
879 assert(o->op_type == OP_MULTIDEREF);
881 other_flags = flags & ~A_HINT_DO;
883 isexdel = o->op_private & (OPpMULTIDEREF_EXISTS|OPpMULTIDEREF_DELETE);
885 if (isexdel & OPpMULTIDEREF_EXISTS) {
886 flags &= A_HINT_EXISTS;
888 flags &= A_HINT_DELETE;
891 if (o->op_flags & OPf_MOD) {
892 flags &= A_HINT_STORE;
894 flags &= A_HINT_FETCH;
898 return flags ? (flags | other_flags) : 0;
901 static SV *a_do_fake_pp(pTHX_ OP *op) {
902 #define a_do_fake_pp(O) a_do_fake_pp(aTHX_ (O))
908 PL_op->op_ppaddr(aTHX);
922 static void a_do_fake_pp_unop_init(pTHX_ UNOP *unop, U32 type, U32 flags) {
923 #define a_do_fake_pp_unop_init(O, T, F) a_do_fake_pp_unop_init(aTHX_ (O), (T), (F))
924 unop->op_type = type;
925 unop->op_flags = OPf_WANT_SCALAR | (~OPf_WANT & flags);
926 unop->op_private = 0;
927 unop->op_first = NULL;
928 unop->op_ppaddr = PL_ppaddr[type];
931 static SV *a_do_fake_pp_unop_arg1(pTHX_ U32 type, U32 flags, SV *arg) {
932 #define a_do_fake_pp_unop_arg1(T, F, A) a_do_fake_pp_unop_arg1(aTHX_ (T), (F), (A))
936 a_do_fake_pp_unop_init(&unop, type, flags);
942 return a_do_fake_pp((OP *) &unop);
945 static SV *a_do_fake_pp_unop_arg2(pTHX_ U32 type, U32 flags, SV *arg1, SV *arg2) {
946 #define a_do_fake_pp_unop_arg2(T, F, A1, A2) a_do_fake_pp_unop_arg2(aTHX_ (T), (F), (A1), (A2))
950 a_do_fake_pp_unop_init(&unop, type, flags);
957 return a_do_fake_pp((OP *) &unop);
960 #define a_do_pp_rv2av(R) a_do_fake_pp_unop_arg1(OP_RV2AV, OPf_REF, (R))
961 #define a_do_pp_afetch(A, I) a_do_fake_pp_unop_arg2(OP_AELEM, 0, (A), (I))
962 #define a_do_pp_afetch_lv(A, I) a_do_fake_pp_unop_arg2(OP_AELEM, OPf_MOD, (A), (I))
963 #define a_do_pp_aexists(A, I) a_do_fake_pp_unop_arg2(OP_EXISTS, OPf_SPECIAL, (A), (I))
964 #define a_do_pp_adelete(A, I) a_do_fake_pp_unop_arg2(OP_DELETE, OPf_SPECIAL, (A), (I))
966 #define a_do_pp_rv2hv(R) a_do_fake_pp_unop_arg1(OP_RV2HV, OPf_REF, (R))
967 #define a_do_pp_hfetch(H, K) a_do_fake_pp_unop_arg2(OP_HELEM, 0, (H), (K))
968 #define a_do_pp_hfetch_lv(H, K) a_do_fake_pp_unop_arg2(OP_HELEM, OPf_MOD, (H), (K))
969 #define a_do_pp_hexists(H, K) a_do_fake_pp_unop_arg2(OP_EXISTS, 0, (H), (K))
970 #define a_do_pp_hdelete(H, K) a_do_fake_pp_unop_arg2(OP_DELETE, 0, (H), (K))
972 static OP *a_pp_multideref(pTHX) {
973 UNOP_AUX_item *items;
981 const a_op_info *oi = a_map_fetch(PL_op);
983 flags = a_do_multideref(PL_op, oi->flags);
985 return oi->old_pp(aTHX);
988 items = cUNOP_AUXx(PL_op)->op_aux;
991 PL_multideref_pc = items;
994 switch (actions & MDEREF_ACTION_MASK) {
996 actions = (++items)->uv;
998 case MDEREF_AV_padav_aelem: /* $lex[...] */
999 sv = PAD_SVl((++items)->pad_offset);
1003 case MDEREF_AV_gvav_aelem: /* $pkg[...] */
1004 sv = UNOP_AUX_item_sv(++items);
1005 assert(isGV_with_GP(sv));
1006 sv = (SV *) GvAVn((GV *) sv);
1010 case MDEREF_AV_pop_rv2av_aelem: /* expr->[...] */
1014 goto do_AV_rv2av_aelem;
1015 case MDEREF_AV_gvsv_vivify_rv2av_aelem: /* $pkg->[...] */
1016 sv = UNOP_AUX_item_sv(++items);
1017 assert(isGV_with_GP(sv));
1018 sv = GvSVn((GV *) sv);
1021 goto do_AV_vivify_rv2av_aelem;
1022 case MDEREF_AV_padsv_vivify_rv2av_aelem: /* $lex->[...] */
1023 sv = PAD_SVl((++items)->pad_offset);
1025 case MDEREF_AV_vivify_rv2av_aelem: /* vivify, ->[...] */
1028 do_AV_vivify_rv2av_aelem:
1029 sv = Perl_vivify_ref(aTHX_ sv, OPpDEREF_AV);
1031 sv = a_do_pp_rv2av(sv);
1035 assert(SvTYPE(sv) == SVt_PVAV);
1036 switch (actions & MDEREF_INDEX_MASK) {
1037 case MDEREF_INDEX_none:
1039 case MDEREF_INDEX_const:
1040 esv = sv_2mortal(newSViv((++items)->iv));
1042 case MDEREF_INDEX_padsv:
1043 esv = PAD_SVl((++items)->pad_offset);
1045 case MDEREF_INDEX_gvsv:
1046 esv = UNOP_AUX_item_sv(++items);
1047 assert(isGV_with_GP(esv));
1048 esv = GvSVn((GV *) esv);
1050 if (UNLIKELY(SvROK(esv) && !SvGAMAGIC(esv) && ckWARN(WARN_MISC)))
1051 Perl_warner(aTHX_ packWARN(WARN_MISC),
1052 "Use of reference \"%"SVf"\" as array index",
1056 PL_multideref_pc = items;
1057 if (actions & MDEREF_FLAG_last) {
1058 switch (flags & A_HINT_DO) {
1060 sv = a_do_pp_afetch(sv, esv);
1063 sv = a_do_pp_afetch_lv(sv, esv);
1066 sv = a_do_pp_aexists(sv, esv);
1069 sv = a_do_pp_adelete(sv, esv);
1074 sv = a_do_pp_afetch(sv, esv);
1077 case MDEREF_HV_padhv_helem: /* $lex{...} */
1078 sv = PAD_SVl((++items)->pad_offset);
1082 case MDEREF_HV_gvhv_helem: /* $pkg{...} */
1083 sv = UNOP_AUX_item_sv(++items);
1084 assert(isGV_with_GP(sv));
1085 sv = (SV *) GvHVn((GV *) sv);
1089 case MDEREF_HV_pop_rv2hv_helem: /* expr->{...} */
1093 goto do_HV_rv2hv_helem;
1094 case MDEREF_HV_gvsv_vivify_rv2hv_helem: /* $pkg->{...} */
1095 sv = UNOP_AUX_item_sv(++items);
1096 assert(isGV_with_GP(sv));
1097 sv = GvSVn((GV *) sv);
1100 goto do_HV_vivify_rv2hv_helem;
1101 case MDEREF_HV_padsv_vivify_rv2hv_helem: /* $lex->{...} */
1102 sv = PAD_SVl((++items)->pad_offset);
1104 case MDEREF_HV_vivify_rv2hv_helem: /* vivify, ->{...} */
1107 do_HV_vivify_rv2hv_helem:
1108 sv = Perl_vivify_ref(aTHX_ sv, OPpDEREF_HV);
1110 sv = a_do_pp_rv2hv(sv);
1114 assert(SvTYPE(sv) == SVt_PVHV);
1115 switch (actions & MDEREF_INDEX_MASK) {
1116 case MDEREF_INDEX_none:
1118 case MDEREF_INDEX_const:
1119 key = UNOP_AUX_item_sv(++items);
1121 case MDEREF_INDEX_padsv:
1122 key = PAD_SVl((++items)->pad_offset);
1124 case MDEREF_INDEX_gvsv:
1125 key = UNOP_AUX_item_sv(++items);
1126 assert(isGV_with_GP(key));
1127 key = GvSVn((GV *) key);
1130 PL_multideref_pc = items;
1131 if (actions & MDEREF_FLAG_last) {
1132 switch (flags & A_HINT_DO) {
1134 sv = a_do_pp_hfetch(sv, key);
1137 sv = a_do_pp_hfetch_lv(sv, key);
1140 sv = a_do_pp_hexists(sv, key);
1143 sv = a_do_pp_hdelete(sv, key);
1150 sv = a_do_pp_hfetch(sv, key);
1155 actions >>= MDEREF_SHIFT;
1159 if (flags & (A_HINT_NOTIFY|A_HINT_STORE))
1160 a_cannot_vivify(flags);
1161 if (flags & A_HINT_EXISTS)
1170 #endif /* A_HAS_MULTIDEREF */
1172 /* --- Check functions ----------------------------------------------------- */
1174 static void a_recheck_rv2xv(pTHX_ OP *o, OPCODE type, OP *(*new_pp)(pTHX)) {
1175 #define a_recheck_rv2xv(O, T, PP) a_recheck_rv2xv(aTHX_ (O), (T), (PP))
1177 if (o->op_type == type && o->op_ppaddr != new_pp
1178 && cUNOPo->op_first->op_type != OP_GV) {
1180 const a_op_info *oi = a_map_fetch(o);
1182 a_map_store(o, o->op_ppaddr, oi->next, oi->flags);
1183 o->op_ppaddr = new_pp;
1190 /* ... ck_pad{any,sv} ...................................................... */
1192 /* Sadly, the padsv OPs we are interested in don't trigger the padsv check
1193 * function, but are instead manually mutated from a padany. So we store
1194 * the op entry in the op map in the padany check function, and we set their
1195 * op_ppaddr member in our peephole optimizer replacement below. */
1197 static OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
1199 static OP *a_ck_padany(pTHX_ OP *o) {
1202 o = a_old_ck_padany(aTHX_ o);
1205 if (hint & A_HINT_DO)
1206 a_map_store_root(o, o->op_ppaddr, hint);
1213 static OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
1215 static OP *a_ck_padsv(pTHX_ OP *o) {
1218 o = a_old_ck_padsv(aTHX_ o);
1221 if (hint & A_HINT_DO) {
1222 a_map_store_root(o, o->op_ppaddr, hint);
1223 o->op_ppaddr = a_pp_deref;
1230 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
1232 /* Those ops appear both at the root and inside an expression but there's no
1233 * way to distinguish both situations. Worse, we can't even know if we are in a
1234 * modifying context, so the expression can't be resolved yet. It will be at the
1235 * first invocation of a_pp_deref() for this expression. */
1237 static OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
1238 static OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
1239 static OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
1241 static OP *a_ck_deref(pTHX_ OP *o) {
1242 OP * (*old_ck)(pTHX_ OP *o) = 0;
1245 switch (o->op_type) {
1247 old_ck = a_old_ck_aelem;
1248 if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT))
1249 a_recheck_rv2xv(cUNOPo->op_first, OP_RV2AV, a_pp_rv2av);
1252 old_ck = a_old_ck_helem;
1253 if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT))
1254 a_recheck_rv2xv(cUNOPo->op_first, OP_RV2HV, a_pp_rv2hv_simple);
1257 old_ck = a_old_ck_rv2sv;
1260 o = old_ck(aTHX_ o);
1262 #if A_HAS_MULTIDEREF
1263 if (old_ck == a_old_ck_rv2sv && o->op_flags & OPf_KIDS) {
1264 OP *kid = cUNOPo->op_first;
1265 if (kid && kid->op_type == OP_GV) {
1266 if (hint & A_HINT_DO)
1267 a_map_store(kid, kid->op_ppaddr, NULL, hint);
1274 if (hint & A_HINT_DO) {
1275 a_map_store_root(o, o->op_ppaddr, hint);
1276 o->op_ppaddr = a_pp_deref;
1283 /* ... ck_rv2xv (rv2av,rv2hv) .............................................. */
1285 /* Those ops also appear both inisde and at the root, hence the caveats for
1286 * a_ck_deref() still apply here. Since a padsv/rv2sv must appear before a
1287 * rv2[ah]v, resolution is handled by the first call to a_pp_deref() in the
1290 static OP *(*a_old_ck_rv2av)(pTHX_ OP *) = 0;
1291 static OP *(*a_old_ck_rv2hv)(pTHX_ OP *) = 0;
1293 static OP *a_ck_rv2xv(pTHX_ OP *o) {
1294 OP * (*old_ck)(pTHX_ OP *o) = 0;
1295 OP * (*new_pp)(pTHX) = 0;
1298 switch (o->op_type) {
1299 case OP_RV2AV: old_ck = a_old_ck_rv2av; new_pp = a_pp_rv2av; break;
1300 case OP_RV2HV: old_ck = a_old_ck_rv2hv; new_pp = a_pp_rv2hv_simple; break;
1302 o = old_ck(aTHX_ o);
1304 if (cUNOPo->op_first->op_type == OP_GV)
1308 if (hint & A_HINT_DO && !(hint & A_HINT_STRICT)) {
1309 a_map_store_root(o, o->op_ppaddr, hint);
1310 o->op_ppaddr = new_pp;
1317 /* ... ck_xslice (aslice,hslice) ........................................... */
1319 /* I think those are only found at the root, but there's nothing that really
1320 * prevent them to be inside the expression too. We only need to update the
1321 * root so that the rest of the expression will see the right context when
1322 * resolving. That's why we don't replace the ppaddr. */
1324 static OP *(*a_old_ck_aslice)(pTHX_ OP *) = 0;
1325 static OP *(*a_old_ck_hslice)(pTHX_ OP *) = 0;
1327 static OP *a_ck_xslice(pTHX_ OP *o) {
1328 OP * (*old_ck)(pTHX_ OP *o) = 0;
1331 switch (o->op_type) {
1333 old_ck = a_old_ck_aslice;
1336 old_ck = a_old_ck_hslice;
1337 if (hint & A_HINT_DO)
1338 a_recheck_rv2xv(OpSIBLING(cUNOPo->op_first), OP_RV2HV, a_pp_rv2hv);
1341 o = old_ck(aTHX_ o);
1343 if (hint & A_HINT_DO) {
1344 a_map_store_root(o, 0, hint);
1351 /* ... ck_root (exists,delete,keys,values) ................................. */
1353 /* Those ops are only found at the root of a dereferencing expression. We can
1354 * then resolve at compile time if vivification must take place or not. */
1356 static OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
1357 static OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
1358 static OP *(*a_old_ck_keys) (pTHX_ OP *) = 0;
1359 static OP *(*a_old_ck_values)(pTHX_ OP *) = 0;
1361 static OP *a_ck_root(pTHX_ OP *o) {
1362 OP * (*old_ck)(pTHX_ OP *o) = 0;
1363 OP * (*new_pp)(pTHX) = 0;
1364 bool enabled = FALSE;
1367 switch (o->op_type) {
1369 old_ck = a_old_ck_exists;
1370 new_pp = a_pp_root_binop;
1371 enabled = hint & A_HINT_EXISTS;
1374 old_ck = a_old_ck_delete;
1375 new_pp = a_pp_root_binop;
1376 enabled = hint & A_HINT_DELETE;
1379 old_ck = a_old_ck_keys;
1380 new_pp = a_pp_root_unop;
1381 enabled = hint & A_HINT_FETCH;
1384 old_ck = a_old_ck_values;
1385 new_pp = a_pp_root_unop;
1386 enabled = hint & A_HINT_FETCH;
1389 o = old_ck(aTHX_ o);
1391 if (hint & A_HINT_DO) {
1393 a_map_update_flags_topdown(o, hint | A_HINT_DEREF);
1394 a_map_store_root(o, o->op_ppaddr, hint);
1395 o->op_ppaddr = new_pp;
1405 /* ... Our peephole optimizer .............................................. */
1407 static void a_peep_rec(pTHX_ OP *o, ptable *seen);
1409 static void a_peep_rec(pTHX_ OP *o, ptable *seen) {
1410 #define a_peep_rec(O) a_peep_rec(aTHX_ (O), seen)
1411 for (; o; o = o->op_next) {
1413 const a_op_info *oi = NULL;
1417 if (ptable_fetch(seen, o))
1419 ptable_seen_store(seen, o, o);
1422 switch (o->op_type) {
1428 if (ptable_fetch(seen, o))
1430 ptable_seen_store(seen, o, o);
1434 if (o->op_ppaddr != a_pp_deref) {
1435 oi = a_map_fetch(o);
1436 if (oi && (oi->flags & A_HINT_DO)) {
1437 a_map_store(o, o->op_ppaddr, oi->next, oi->flags);
1438 o->op_ppaddr = a_pp_deref;
1446 if (o->op_ppaddr != a_pp_deref)
1448 oi = a_map_fetch(o);
1452 if (!(flags & A_HINT_DEREF)
1453 && (flags & A_HINT_DO)
1454 && (o->op_private & OPpDEREF || flags & A_HINT_ROOT)) {
1455 /* Decide if the expression must autovivify or not. */
1456 flags = a_map_resolve(o, oi);
1458 if (flags & A_HINT_DEREF)
1459 o->op_private = ((o->op_private & ~OPpDEREF) | OPpLVAL_DEFER);
1461 o->op_ppaddr = oi->old_pp;
1465 if ( o->op_ppaddr != a_pp_rv2av
1466 && o->op_ppaddr != a_pp_rv2hv
1467 && o->op_ppaddr != a_pp_rv2hv_simple)
1469 oi = a_map_fetch(o);
1472 if (!(oi->flags & A_HINT_DEREF))
1473 o->op_ppaddr = oi->old_pp;
1475 #if A_HAS_MULTIDEREF
1477 if (o->op_ppaddr != a_pp_multideref) {
1478 oi = a_map_fetch(cUNOPo->op_first);
1482 if (a_do_multideref(o, flags)) {
1483 a_map_store_root(o, o->op_ppaddr, flags & ~A_HINT_DEREF);
1484 o->op_ppaddr = a_pp_multideref;
1498 # if A_HAS_PERL(5, 10, 0)
1503 a_peep_rec(cLOGOPo->op_other);
1507 a_peep_rec(cLOOPo->op_redoop);
1508 a_peep_rec(cLOOPo->op_nextop);
1509 a_peep_rec(cLOOPo->op_lastop);
1511 # if A_HAS_PERL(5, 9, 5)
1513 a_peep_rec(cPMOPo->op_pmstashstartu.op_pmreplstart);
1519 a_peep_rec(cPMOPo->op_pmreplstart);
1522 #endif /* !A_HAS_RPEEP */
1529 static void a_peep(pTHX_ OP *o) {
1533 assert(a_is_loaded(&MY_CXT));
1535 MY_CXT.old_peep(aTHX_ o);
1539 ptable_seen_clear(seen);
1541 ptable_seen_clear(seen);
1545 /* --- Module setup/teardown ----------------------------------------------- */
1547 static void a_teardown(pTHX_ void *root) {
1552 if (a_clear_loaded_locked(&MY_CXT)) {
1553 a_ck_restore(OP_PADANY, &a_old_ck_padany);
1554 a_ck_restore(OP_PADSV, &a_old_ck_padsv);
1556 a_ck_restore(OP_AELEM, &a_old_ck_aelem);
1557 a_ck_restore(OP_HELEM, &a_old_ck_helem);
1558 a_ck_restore(OP_RV2SV, &a_old_ck_rv2sv);
1560 a_ck_restore(OP_RV2AV, &a_old_ck_rv2av);
1561 a_ck_restore(OP_RV2HV, &a_old_ck_rv2hv);
1563 a_ck_restore(OP_ASLICE, &a_old_ck_aslice);
1564 a_ck_restore(OP_HSLICE, &a_old_ck_hslice);
1566 a_ck_restore(OP_EXISTS, &a_old_ck_exists);
1567 a_ck_restore(OP_DELETE, &a_old_ck_delete);
1568 a_ck_restore(OP_KEYS, &a_old_ck_keys);
1569 a_ck_restore(OP_VALUES, &a_old_ck_values);
1571 ptable_map_free(a_op_map);
1577 if (MY_CXT.old_peep) {
1579 PL_rpeepp = MY_CXT.old_peep;
1581 PL_peepp = MY_CXT.old_peep;
1583 MY_CXT.old_peep = 0;
1586 ptable_seen_free(MY_CXT.seen);
1589 #if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
1590 ptable_hints_free(MY_CXT.tbl);
1592 #endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
1597 static void a_setup(pTHX) {
1598 #define a_setup() a_setup(aTHX)
1599 MY_CXT_INIT; /* Takes/release PL_my_ctx_mutex */
1603 if (a_set_loaded_locked(&MY_CXT)) {
1604 PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
1606 a_op_map = ptable_new();
1608 MUTEX_INIT(&a_op_map_mutex);
1611 a_ck_replace(OP_PADANY, a_ck_padany, &a_old_ck_padany);
1612 a_ck_replace(OP_PADSV, a_ck_padsv, &a_old_ck_padsv);
1614 a_ck_replace(OP_AELEM, a_ck_deref, &a_old_ck_aelem);
1615 a_ck_replace(OP_HELEM, a_ck_deref, &a_old_ck_helem);
1616 a_ck_replace(OP_RV2SV, a_ck_deref, &a_old_ck_rv2sv);
1618 a_ck_replace(OP_RV2AV, a_ck_rv2xv, &a_old_ck_rv2av);
1619 a_ck_replace(OP_RV2HV, a_ck_rv2xv, &a_old_ck_rv2hv);
1621 a_ck_replace(OP_ASLICE, a_ck_xslice, &a_old_ck_aslice);
1622 a_ck_replace(OP_HSLICE, a_ck_xslice, &a_old_ck_hslice);
1624 a_ck_replace(OP_EXISTS, a_ck_root, &a_old_ck_exists);
1625 a_ck_replace(OP_DELETE, a_ck_root, &a_old_ck_delete);
1626 a_ck_replace(OP_KEYS, a_ck_root, &a_old_ck_keys);
1627 a_ck_replace(OP_VALUES, a_ck_root, &a_old_ck_values);
1635 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
1636 newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
1637 newCONSTSUB(stash, "A_HINT_WARN", newSVuv(A_HINT_WARN));
1638 newCONSTSUB(stash, "A_HINT_FETCH", newSVuv(A_HINT_FETCH));
1639 newCONSTSUB(stash, "A_HINT_STORE", newSVuv(A_HINT_STORE));
1640 newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
1641 newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
1642 newCONSTSUB(stash, "A_HINT_MASK", newSVuv(A_HINT_MASK));
1643 newCONSTSUB(stash, "A_THREADSAFE", newSVuv(A_THREADSAFE));
1644 newCONSTSUB(stash, "A_FORKSAFE", newSVuv(A_FORKSAFE));
1648 if (PL_rpeepp != a_peep) {
1649 MY_CXT.old_peep = PL_rpeepp;
1653 if (PL_peepp != a_peep) {
1654 MY_CXT.old_peep = PL_peepp;
1659 MY_CXT.old_peep = 0;
1662 MY_CXT.seen = ptable_new();
1664 #if A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION
1665 MY_CXT.tbl = ptable_new();
1666 MY_CXT.owner = aTHX;
1667 #endif /* A_THREADSAFE && A_WORKAROUND_REQUIRE_PROPAGATION */
1669 call_atexit(a_teardown, NULL);
1674 /* --- XS ------------------------------------------------------------------ */
1676 MODULE = autovivification PACKAGE = autovivification
1691 #if A_WORKAROUND_REQUIRE_PROPAGATION
1695 #if A_WORKAROUND_REQUIRE_PROPAGATION
1697 a_ptable_clone_ud ud;
1700 a_ptable_clone_ud_init(ud, t, MY_CXT.owner);
1701 ptable_walk(MY_CXT.tbl, a_ptable_clone, &ud);
1702 a_ptable_clone_ud_deinit(ud);
1707 #if A_WORKAROUND_REQUIRE_PROPAGATION
1709 MY_CXT.owner = aTHX;
1711 MY_CXT.seen = ptable_new();
1715 global_setup = a_set_loaded_locked(&MY_CXT);
1716 assert(!global_setup);
1722 #endif /* A_THREADSAFE */
1728 RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
1738 RETVAL = newSVuv(a_detag(tag));