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 ---------------------------------------------- */
14 #define A_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
16 #ifndef A_WORKAROUND_REQUIRE_PROPAGATION
17 # define A_WORKAROUND_REQUIRE_PROPAGATION !A_HAS_PERL(5, 10, 1)
20 /* --- Helpers ------------------------------------------------------------- */
22 #if A_WORKAROUND_REQUIRE_PROPAGATION
24 #define A_ENCODE_UV(B, U) \
26 while (len < sizeof(UV)) { \
27 (B)[len++] = (U) & 0xFF; \
31 #define A_DECODE_UV(U, B) \
34 (U) = ((U) << 8) | (B)[--len];
36 STATIC SV *a_tag(pTHX_ UV bits) {
37 #define a_tag(B) a_tag(aTHX_ (B))
41 unsigned char buf[sizeof(UV) * 2];
44 for (si = PL_curstackinfo; si; si = si->si_prev) {
47 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
48 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
50 if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE)
55 A_ENCODE_UV(buf, requires);
56 A_ENCODE_UV(buf + sizeof(UV), bits);
57 hint = newSVpvn(buf, sizeof buf);
63 STATIC UV a_detag(pTHX_ const SV *hint) {
64 #define a_detag(H) a_detag(aTHX_ (H))
66 UV requires = 0, requires_max = 0, bits = 0;
70 if (!(hint && SvOK(hint)))
74 A_DECODE_UV(requires_max, buf);
76 for (si = PL_curstackinfo; si; si = si->si_prev) {
79 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
80 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
82 if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE
83 && ++requires > requires_max)
88 A_DECODE_UV(bits, buf + sizeof(UV));
93 #else /* A_WORKAROUND_REQUIRE_PROPAGATION */
95 #define a_tag(B) newSVuv(B)
96 #define a_detag(H) (((H) && SvOK(H)) ? SvUVX(H) : 0)
98 #endif /* !A_WORKAROUND_REQUIRE_PROPAGATION */
100 /* Used both for hints and op flags */
101 #define A_HINT_STRICT 1
102 #define A_HINT_WARN 2
103 #define A_HINT_FETCH 4
104 #define A_HINT_STORE 8
105 #define A_HINT_EXISTS 16
106 #define A_HINT_DELETE 32
107 #define A_HINT_NOTIFY (A_HINT_STRICT|A_HINT_WARN)
108 #define A_HINT_DO (A_HINT_FETCH|A_HINT_STORE|A_HINT_EXISTS|A_HINT_DELETE)
109 #define A_HINT_MASK (A_HINT_NOTIFY|A_HINT_DO)
111 /* Only used in op flags */
112 #define A_HINT_DEREF 64
114 STATIC U32 a_hash = 0;
116 STATIC UV a_hint(pTHX) {
117 #define a_hint() a_hint(aTHX)
119 #if A_HAS_PERL(5, 9, 5)
120 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
122 __PACKAGE__, __PACKAGE_LEN__,
126 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, a_hash);
131 return a_detag(hint);
134 /* ... op => info map ...................................................... */
142 #define PTABLE_NAME ptable_map
143 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
147 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
148 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
150 STATIC ptable *a_op_map = NULL;
153 STATIC perl_mutex a_op_map_mutex;
156 STATIC void a_map_store(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), UV flags) {
157 #define a_map_store(O, PP, F) a_map_store(aPTBLMS_ (O), (PP), (F))
161 MUTEX_LOCK(&a_op_map_mutex);
164 if (!(oi = ptable_fetch(a_op_map, o))) {
165 oi = PerlMemShared_malloc(sizeof *oi);
166 ptable_map_store(a_op_map, o, oi);
174 MUTEX_UNLOCK(&a_op_map_mutex);
178 STATIC const a_op_info *a_map_fetch(const OP *o, a_op_info *oi) {
179 const a_op_info *val;
182 MUTEX_LOCK(&a_op_map_mutex);
185 val = ptable_fetch(a_op_map, o);
192 MUTEX_UNLOCK(&a_op_map_mutex);
198 STATIC void a_map_delete(pTHX_ const OP *o) {
199 #define a_map_delete(O) a_map_delete(aTHX_ (O))
201 MUTEX_LOCK(&a_op_map_mutex);
204 ptable_map_store(a_op_map, o, NULL);
207 MUTEX_UNLOCK(&a_op_map_mutex);
211 STATIC void a_map_set_root(const OP *root, UV flags) {
216 MUTEX_LOCK(&a_op_map_mutex);
220 if (oi = ptable_fetch(a_op_map, o)) {
224 if (!(o->op_flags & OPf_KIDS))
226 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
230 case OA_BASEOP_OR_UNOP:
231 o = cUNOPo->op_first;
235 o = cLISTOPo->op_last;
244 MUTEX_UNLOCK(&a_op_map_mutex);
250 /* ... Lightweight pp_defined() ............................................ */
252 STATIC bool a_defined(pTHX_ SV *sv) {
253 #define a_defined(S) a_defined(aTHX_ (S))
254 bool defined = FALSE;
256 switch (SvTYPE(sv)) {
258 if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
259 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
263 if (HvARRAY(sv) || SvGMAGICAL(sv)
264 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
274 /* --- PP functions -------------------------------------------------------- */
276 /* ... pp_rv2av ............................................................ */
278 STATIC OP *a_pp_rv2av(pTHX) {
283 a_map_fetch(PL_op, &oi);
285 if (PL_op == oi.root) { /* This means "@$arrayref" */
286 PL_op->op_ppaddr = oi.old_pp;
287 } else if (!SvOK(TOPs)) {
288 /* We always need to push an empty array to fool the pp_aelem() that comes
292 av = sv_2mortal((SV *) newAV());
297 return CALL_FPTR(oi.old_pp)(aTHX);
300 /* ... pp_rv2hv ............................................................ */
302 STATIC OP *a_pp_rv2hv(pTHX) {
307 a_map_fetch(PL_op, &oi);
309 if (PL_op == oi.root) { /* This means "%$hashref" */
310 PL_op->op_ppaddr = oi.old_pp;
311 } else if (!SvOK(TOPs)) {
315 return CALL_FPTR(oi.old_pp)(aTHX);
318 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
320 STATIC OP *a_pp_deref(pTHX) {
325 a_map_fetch(PL_op, &oi);
328 if (flags & A_HINT_DEREF) {
333 old_private = PL_op->op_private;
334 PL_op->op_private = ((old_private & ~OPpDEREF) | OPpLVAL_DEFER);
335 o = CALL_FPTR(oi.old_pp)(aTHX);
336 PL_op->op_private = old_private;
338 if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
341 if (flags & A_HINT_STRICT)
342 croak("Reference vivification forbidden");
343 else if (flags & A_HINT_WARN)
344 warn("Reference was vivified");
345 else /* A_HINT_STORE */
346 croak("Can't vivify reference");
351 } else if (flags && (PL_op->op_private & OPpDEREF || PL_op == oi.root)) {
352 oi.flags = flags & A_HINT_NOTIFY;
354 if (oi.root->op_flags & OPf_MOD) {
355 if (flags & A_HINT_STORE)
356 oi.flags |= (A_HINT_STORE|A_HINT_DEREF);
357 } else if (flags & A_HINT_FETCH)
358 oi.flags |= (A_HINT_FETCH|A_HINT_DEREF);
360 if (PL_op == oi.root)
361 oi.flags &= ~A_HINT_DEREF;
363 /* We will need the updated flags value in the deref part */
366 if (flags & A_HINT_DEREF)
369 /* This op doesn't need to skip autovivification, so restore the original
370 * state. Be aware that another extension might have saved a_pp_deref as the
371 * ppaddr for this op, so restoring PL_op->op_ppaddr doesn't ensure that this
372 * function will never be called again. That's why we don't remove the op info
373 * from our map and we reset oi.flags to 0, so that it can still run correctly
376 PL_op->op_ppaddr = oi.old_pp;
379 return CALL_FPTR(oi.old_pp)(aTHX);
382 /* ... pp_root (exists,delete,keys,values) ................................. */
384 STATIC OP *a_pp_root_unop(pTHX) {
388 if (!a_defined(TOPs)) {
390 /* Can only be reached by keys or values */
391 if (GIMME_V == G_SCALAR) {
398 a_map_fetch(PL_op, &oi);
400 return CALL_FPTR(oi.old_pp)(aTHX);
403 STATIC OP *a_pp_root_binop(pTHX) {
407 if (!a_defined(TOPm1s)) {
410 if (PL_op->op_type == OP_EXISTS)
416 a_map_fetch(PL_op, &oi);
418 return CALL_FPTR(oi.old_pp)(aTHX);
421 /* --- Check functions ----------------------------------------------------- */
423 /* ... ck_pad{any,sv} ...................................................... */
425 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
426 * function, but are instead manually mutated from a PADANY. This is why we set
427 * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
428 * their op_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
429 * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
430 * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
433 STATIC OP *(*a_pp_padsv_saved)(pTHX) = 0;
435 STATIC void a_pp_padsv_save(void) {
436 if (a_pp_padsv_saved)
439 a_pp_padsv_saved = PL_ppaddr[OP_PADSV];
440 PL_ppaddr[OP_PADSV] = a_pp_deref;
443 STATIC void a_pp_padsv_restore(OP *o) {
444 if (!a_pp_padsv_saved)
447 if (o->op_ppaddr == a_pp_deref)
448 o->op_ppaddr = a_pp_padsv_saved;
450 PL_ppaddr[OP_PADSV] = a_pp_padsv_saved;
451 a_pp_padsv_saved = 0;
454 STATIC OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
456 STATIC OP *a_ck_padany(pTHX_ OP *o) {
459 a_pp_padsv_restore(o);
461 o = CALL_FPTR(a_old_ck_padany)(aTHX_ o);
464 if (hint & A_HINT_DO) {
466 a_map_store(o, a_pp_padsv_saved, hint);
473 STATIC OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
475 STATIC OP *a_ck_padsv(pTHX_ OP *o) {
478 a_pp_padsv_restore(o);
480 o = CALL_FPTR(a_old_ck_padsv)(aTHX_ o);
483 if (hint & A_HINT_DO) {
484 a_map_store(o, o->op_ppaddr, hint);
485 o->op_ppaddr = a_pp_deref;
492 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
494 STATIC OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
495 STATIC OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
496 STATIC OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
498 STATIC OP *a_ck_deref(pTHX_ OP *o) {
499 OP * (*old_ck)(pTHX_ OP *o) = 0;
502 switch (o->op_type) {
504 old_ck = a_old_ck_aelem;
505 if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT)) {
506 OP *kid = cUNOPo->op_first;
508 if (kid->op_type == OP_RV2AV && kid->op_ppaddr != a_pp_rv2av
509 && kUNOP->op_first->op_type != OP_GV
510 && a_map_fetch(kid, &oi)) {
511 a_map_store(kid, kid->op_ppaddr, hint);
512 kid->op_ppaddr = a_pp_rv2av;
517 old_ck = a_old_ck_helem;
518 if ((hint & A_HINT_DO) && !(hint & A_HINT_STRICT)) {
519 OP *kid = cUNOPo->op_first;
521 if (kid->op_type == OP_RV2HV && kid->op_ppaddr != a_pp_rv2hv
522 && kUNOP->op_first->op_type != OP_GV
523 && a_map_fetch(kid, &oi)) {
524 a_map_store(kid, kid->op_ppaddr, hint);
525 kid->op_ppaddr = a_pp_rv2hv;
530 old_ck = a_old_ck_rv2sv;
533 o = CALL_FPTR(old_ck)(aTHX_ o);
535 if (hint & A_HINT_DO) {
536 a_map_store(o, o->op_ppaddr, hint);
537 o->op_ppaddr = a_pp_deref;
538 a_map_set_root(o, hint);
545 /* ... ck_rv2xv (rv2av,rv2hv) .............................................. */
547 STATIC OP *(*a_old_ck_rv2av)(pTHX_ OP *) = 0;
548 STATIC OP *(*a_old_ck_rv2hv)(pTHX_ OP *) = 0;
550 STATIC OP *a_ck_rv2xv(pTHX_ OP *o) {
551 OP * (*old_ck)(pTHX_ OP *o) = 0;
552 OP * (*new_pp)(pTHX) = 0;
555 switch (o->op_type) {
556 case OP_RV2AV: old_ck = a_old_ck_rv2av; new_pp = a_pp_rv2av; break;
557 case OP_RV2HV: old_ck = a_old_ck_rv2hv; new_pp = a_pp_rv2hv; break;
559 o = CALL_FPTR(old_ck)(aTHX_ o);
561 if (cUNOPo->op_first->op_type == OP_GV)
565 if (hint & A_HINT_DO) {
566 if (!(hint & A_HINT_STRICT)) {
567 a_map_store(o, o->op_ppaddr, hint);
568 o->op_ppaddr = new_pp;
570 a_map_set_root(o, hint);
577 /* ... ck_root (exists,delete,keys,values) ................................. */
579 STATIC OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
580 STATIC OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
581 STATIC OP *(*a_old_ck_keys) (pTHX_ OP *) = 0;
582 STATIC OP *(*a_old_ck_values)(pTHX_ OP *) = 0;
584 STATIC OP *a_ck_root(pTHX_ OP *o) {
585 OP * (*old_ck)(pTHX_ OP *o) = 0;
586 OP * (*new_pp)(pTHX) = 0;
587 bool enabled = FALSE;
590 switch (o->op_type) {
592 old_ck = a_old_ck_exists;
593 new_pp = a_pp_root_binop;
594 enabled = hint & A_HINT_EXISTS;
597 old_ck = a_old_ck_delete;
598 new_pp = a_pp_root_binop;
599 enabled = hint & A_HINT_DELETE;
602 old_ck = a_old_ck_keys;
603 new_pp = a_pp_root_unop;
604 enabled = hint & A_HINT_FETCH;
607 old_ck = a_old_ck_values;
608 new_pp = a_pp_root_unop;
609 enabled = hint & A_HINT_FETCH;
612 o = CALL_FPTR(old_ck)(aTHX_ o);
614 if (hint & A_HINT_DO) {
616 a_map_set_root(o, hint | A_HINT_DEREF);
617 a_map_store(o, o->op_ppaddr, hint);
618 o->op_ppaddr = new_pp;
620 a_map_set_root(o, 0);
628 STATIC U32 a_initialized = 0;
630 /* --- XS ------------------------------------------------------------------ */
632 MODULE = autovivification PACKAGE = autovivification
638 if (!a_initialized++) {
641 a_op_map = ptable_new();
643 MUTEX_INIT(&a_op_map_mutex);
646 PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
648 a_old_ck_padany = PL_check[OP_PADANY];
649 PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_ck_padany);
650 a_old_ck_padsv = PL_check[OP_PADSV];
651 PL_check[OP_PADSV] = MEMBER_TO_FPTR(a_ck_padsv);
653 a_old_ck_aelem = PL_check[OP_AELEM];
654 PL_check[OP_AELEM] = MEMBER_TO_FPTR(a_ck_deref);
655 a_old_ck_helem = PL_check[OP_HELEM];
656 PL_check[OP_HELEM] = MEMBER_TO_FPTR(a_ck_deref);
657 a_old_ck_rv2sv = PL_check[OP_RV2SV];
658 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(a_ck_deref);
660 a_old_ck_rv2av = PL_check[OP_RV2AV];
661 PL_check[OP_RV2AV] = MEMBER_TO_FPTR(a_ck_rv2xv);
662 a_old_ck_rv2hv = PL_check[OP_RV2HV];
663 PL_check[OP_RV2HV] = MEMBER_TO_FPTR(a_ck_rv2xv);
665 a_old_ck_exists = PL_check[OP_EXISTS];
666 PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_ck_root);
667 a_old_ck_delete = PL_check[OP_DELETE];
668 PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_ck_root);
669 a_old_ck_keys = PL_check[OP_KEYS];
670 PL_check[OP_KEYS] = MEMBER_TO_FPTR(a_ck_root);
671 a_old_ck_values = PL_check[OP_VALUES];
672 PL_check[OP_VALUES] = MEMBER_TO_FPTR(a_ck_root);
674 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
675 newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
676 newCONSTSUB(stash, "A_HINT_WARN", newSVuv(A_HINT_WARN));
677 newCONSTSUB(stash, "A_HINT_FETCH", newSVuv(A_HINT_FETCH));
678 newCONSTSUB(stash, "A_HINT_STORE", newSVuv(A_HINT_STORE));
679 newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
680 newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
681 newCONSTSUB(stash, "A_HINT_MASK", newSVuv(A_HINT_MASK));
689 RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
699 RETVAL = newSVuv(a_detag(tag));