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
29 STATIC SV *a_tag(pTHX_ UV bits) {
30 #define a_tag(B) a_tag(aTHX_ (B))
40 for (si = PL_curstackinfo; si; si = si->si_prev) {
43 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
44 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
46 if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE)
51 h.requires = requires;
54 return newSVpvn((const char *) &h, sizeof h);
57 STATIC UV a_detag(pTHX_ const SV *hint) {
58 #define a_detag(H) a_detag(aTHX_ (H))
61 if (!(hint && SvOK(hint)))
64 h = (const a_hint_t *) SvPVX(hint);
70 for (si = PL_curstackinfo; si; si = si->si_prev) {
73 for (cxix = si->si_cxix; cxix >= 0; --cxix) {
74 const PERL_CONTEXT *cx = si->si_cxstack + cxix;
76 if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE
77 && ++requires > h->requires)
86 #else /* A_WORKAROUND_REQUIRE_PROPAGATION */
88 #define a_tag(B) newSVuv(B)
89 #define a_detag(H) (((H) && SvOK(H)) ? SvUVX(H) : 0)
91 #endif /* !A_WORKAROUND_REQUIRE_PROPAGATION */
93 /* Used both for hints and op flags */
94 #define A_HINT_STRICT 1
96 #define A_HINT_FETCH 4
97 #define A_HINT_STORE 8
98 #define A_HINT_EXISTS 16
99 #define A_HINT_DELETE 32
100 #define A_HINT_NOTIFY (A_HINT_STRICT|A_HINT_WARN)
101 #define A_HINT_DO (A_HINT_FETCH|A_HINT_STORE|A_HINT_EXISTS|A_HINT_DELETE)
102 #define A_HINT_MASK (A_HINT_NOTIFY|A_HINT_DO)
104 /* Only used in op flags */
105 #define A_HINT_DEREF 64
107 STATIC U32 a_hash = 0;
109 STATIC UV a_hint(pTHX) {
110 #define a_hint() a_hint(aTHX)
112 #if A_HAS_PERL(5, 9, 5)
113 hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
115 __PACKAGE__, __PACKAGE_LEN__,
119 SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, a_hash);
124 return a_detag(hint);
127 /* ... op => info map ...................................................... */
135 #define PTABLE_NAME ptable_map
136 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
140 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
141 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
143 STATIC ptable *a_op_map = NULL;
146 STATIC perl_mutex a_op_map_mutex;
149 STATIC void a_map_store(pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), UV flags) {
150 #define a_map_store(O, PP, F) a_map_store(aPTBLMS_ (O), (PP), (F))
154 MUTEX_LOCK(&a_op_map_mutex);
157 if (!(oi = ptable_fetch(a_op_map, o))) {
158 oi = PerlMemShared_malloc(sizeof *oi);
159 ptable_map_store(a_op_map, o, oi);
167 MUTEX_UNLOCK(&a_op_map_mutex);
171 STATIC const a_op_info *a_map_fetch(const OP *o, a_op_info *oi) {
172 const a_op_info *val;
175 MUTEX_LOCK(&a_op_map_mutex);
178 val = ptable_fetch(a_op_map, o);
182 MUTEX_UNLOCK(&a_op_map_mutex);
188 STATIC void a_map_delete(pTHX_ const OP *o) {
189 #define a_map_delete(O) a_map_delete(aTHX_ (O))
191 MUTEX_LOCK(&a_op_map_mutex);
194 ptable_map_store(a_op_map, o, NULL);
197 MUTEX_UNLOCK(&a_op_map_mutex);
201 STATIC void a_map_set_root(const OP *root, UV flags) {
206 MUTEX_LOCK(&a_op_map_mutex);
210 if (oi = ptable_fetch(a_op_map, o)) {
214 if (!(o->op_flags & OPf_KIDS))
216 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
220 case OA_BASEOP_OR_UNOP:
221 o = cUNOPo->op_first;
225 o = cLISTOPo->op_last;
234 MUTEX_UNLOCK(&a_op_map_mutex);
240 /* ... Lightweight pp_defined() ............................................ */
242 STATIC bool a_defined(pTHX_ SV *sv) {
243 #define a_defined(S) a_defined(aTHX_ (S))
244 bool defined = FALSE;
246 switch (SvTYPE(sv)) {
248 if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
249 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
253 if (HvARRAY(sv) || SvGMAGICAL(sv)
254 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
264 /* --- PP functions -------------------------------------------------------- */
266 /* ... pp_rv2av ............................................................ */
268 STATIC OP *a_pp_rv2av(pTHX) {
273 a_map_fetch(PL_op, &oi);
275 if (PL_op == oi.root) { /* This means "@$arrayref" */
276 PL_op->op_ppaddr = oi.old_pp;
277 } else if (!SvOK(TOPs)) {
278 /* We always need to push an empty array to fool the pp_aelem() that comes
282 av = sv_2mortal((SV *) newAV());
287 return CALL_FPTR(oi.old_pp)(aTHX);
290 /* ... pp_rv2hv ............................................................ */
292 STATIC OP *a_pp_rv2hv(pTHX) {
297 a_map_fetch(PL_op, &oi);
299 if (PL_op == oi.root) { /* This means "%$hashref" */
300 PL_op->op_ppaddr = oi.old_pp;
301 } else if (!SvOK(TOPs)) {
302 if (oi.root->op_flags & OPf_MOD) {
305 hv = sv_2mortal((SV *) newHV());
311 return CALL_FPTR(oi.old_pp)(aTHX);
314 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
316 STATIC OP *a_pp_deref(pTHX) {
321 a_map_fetch(PL_op, &oi);
324 if (flags & A_HINT_DEREF) {
329 old_private = PL_op->op_private;
330 PL_op->op_private = ((old_private & ~OPpDEREF) | OPpLVAL_DEFER);
331 o = CALL_FPTR(oi.old_pp)(aTHX);
332 PL_op->op_private = old_private;
334 if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
337 if (flags & A_HINT_STRICT)
338 croak("Reference vivification forbidden");
339 else if (flags & A_HINT_WARN)
340 warn("Reference was vivified");
341 else /* A_HINT_STORE */
342 croak("Can't vivify reference");
347 } else if (flags && (PL_op->op_private & OPpDEREF || PL_op == oi.root)) {
348 oi.flags = flags & A_HINT_NOTIFY;
350 if ((oi.root->op_flags & (OPf_MOD|OPf_REF)) != (OPf_MOD|OPf_REF)) {
351 if (flags & A_HINT_FETCH)
352 oi.flags |= (A_HINT_FETCH|A_HINT_DEREF);
353 } else if (flags & A_HINT_STORE)
354 oi.flags |= (A_HINT_STORE|A_HINT_DEREF);
356 if (PL_op == oi.root)
357 oi.flags &= ~A_HINT_DEREF;
359 /* We will need the updated flags value in the deref part */
362 if (flags & A_HINT_DEREF)
365 /* This op doesn't need to skip autovivification, so restore the original
366 * state. Be aware that another extension might have saved a_pp_deref as the
367 * ppaddr for this op, so restoring PL_op->op_ppaddr doesn't ensure that this
368 * function will never be called again. That's why we don't remove the op info
369 * from our map and we reset oi.flags to 0, so that it can still run correctly
372 PL_op->op_ppaddr = oi.old_pp;
375 return CALL_FPTR(oi.old_pp)(aTHX);
378 /* ... pp_root (exists,delete,keys,values) ................................. */
380 STATIC OP *a_pp_root_unop(pTHX) {
384 if (!a_defined(TOPs)) {
386 /* Can only be reached by keys or values */
387 if (GIMME_V == G_SCALAR) {
394 a_map_fetch(PL_op, &oi);
396 return CALL_FPTR(oi.old_pp)(aTHX);
399 STATIC OP *a_pp_root_binop(pTHX) {
403 if (!a_defined(TOPm1s)) {
406 if (PL_op->op_type == OP_EXISTS)
412 a_map_fetch(PL_op, &oi);
414 return CALL_FPTR(oi.old_pp)(aTHX);
417 /* --- Check functions ----------------------------------------------------- */
419 /* ... ck_pad{any,sv} ...................................................... */
421 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
422 * function, but are instead manually mutated from a PADANY. This is why we set
423 * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
424 * their op_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
425 * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
426 * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
429 STATIC OP *(*a_pp_padsv_saved)(pTHX) = 0;
431 STATIC void a_pp_padsv_save(void) {
432 if (a_pp_padsv_saved)
435 a_pp_padsv_saved = PL_ppaddr[OP_PADSV];
436 PL_ppaddr[OP_PADSV] = a_pp_deref;
439 STATIC void a_pp_padsv_restore(OP *o) {
440 if (!a_pp_padsv_saved)
443 if (o->op_ppaddr == a_pp_deref)
444 o->op_ppaddr = a_pp_padsv_saved;
446 PL_ppaddr[OP_PADSV] = a_pp_padsv_saved;
447 a_pp_padsv_saved = 0;
450 STATIC OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
452 STATIC OP *a_ck_padany(pTHX_ OP *o) {
455 a_pp_padsv_restore(o);
457 o = CALL_FPTR(a_old_ck_padany)(aTHX_ o);
460 if (hint & A_HINT_DO) {
462 a_map_store(o, a_pp_padsv_saved, hint);
469 STATIC OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
471 STATIC OP *a_ck_padsv(pTHX_ OP *o) {
474 a_pp_padsv_restore(o);
476 o = CALL_FPTR(a_old_ck_padsv)(aTHX_ o);
479 if (hint & A_HINT_DO) {
480 a_map_store(o, o->op_ppaddr, hint);
481 o->op_ppaddr = a_pp_deref;
488 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
490 STATIC OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
491 STATIC OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
492 STATIC OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
494 STATIC OP *a_ck_deref(pTHX_ OP *o) {
495 OP * (*old_ck)(pTHX_ OP *o) = 0;
498 switch (o->op_type) {
499 case OP_AELEM: old_ck = a_old_ck_aelem; break;
500 case OP_HELEM: old_ck = a_old_ck_helem; break;
501 case OP_RV2SV: old_ck = a_old_ck_rv2sv; break;
503 o = CALL_FPTR(old_ck)(aTHX_ o);
506 if (hint & A_HINT_DO) {
507 a_map_store(o, o->op_ppaddr, hint);
508 o->op_ppaddr = a_pp_deref;
509 a_map_set_root(o, hint);
516 /* ... ck_rv2xv (rv2av,rv2hv) .............................................. */
518 STATIC OP *(*a_old_ck_rv2av)(pTHX_ OP *) = 0;
519 STATIC OP *(*a_old_ck_rv2hv)(pTHX_ OP *) = 0;
521 STATIC OP *a_ck_rv2xv(pTHX_ OP *o) {
522 OP * (*old_ck)(pTHX_ OP *o) = 0;
523 OP * (*new_pp)(pTHX) = 0;
526 switch (o->op_type) {
527 case OP_RV2AV: old_ck = a_old_ck_rv2av; new_pp = a_pp_rv2av; break;
528 case OP_RV2HV: old_ck = a_old_ck_rv2hv; new_pp = a_pp_rv2hv; break;
530 o = CALL_FPTR(old_ck)(aTHX_ o);
532 if (cUNOPo->op_first->op_type == OP_GV)
536 if (hint & A_HINT_DO) {
537 if (!(hint & A_HINT_STRICT)) {
538 a_map_store(o, o->op_ppaddr, hint);
539 o->op_ppaddr = new_pp;
541 a_map_set_root(o, hint);
548 /* ... ck_root (exists,delete,keys,values) ................................. */
550 STATIC OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
551 STATIC OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
552 STATIC OP *(*a_old_ck_keys) (pTHX_ OP *) = 0;
553 STATIC OP *(*a_old_ck_values)(pTHX_ OP *) = 0;
555 STATIC OP *a_ck_root(pTHX_ OP *o) {
556 OP * (*old_ck)(pTHX_ OP *o) = 0;
557 OP * (*new_pp)(pTHX) = 0;
558 bool enabled = FALSE;
561 switch (o->op_type) {
563 old_ck = a_old_ck_exists;
564 new_pp = a_pp_root_binop;
565 enabled = hint & A_HINT_EXISTS;
568 old_ck = a_old_ck_delete;
569 new_pp = a_pp_root_binop;
570 enabled = hint & A_HINT_DELETE;
573 old_ck = a_old_ck_keys;
574 new_pp = a_pp_root_unop;
575 enabled = hint & A_HINT_FETCH;
578 old_ck = a_old_ck_values;
579 new_pp = a_pp_root_unop;
580 enabled = hint & A_HINT_FETCH;
583 o = CALL_FPTR(old_ck)(aTHX_ o);
585 if (hint & A_HINT_DO) {
587 a_map_set_root(o, hint | A_HINT_DEREF);
588 a_map_store(o, o->op_ppaddr, hint);
589 o->op_ppaddr = new_pp;
591 a_map_set_root(o, 0);
599 STATIC U32 a_initialized = 0;
601 /* --- XS ------------------------------------------------------------------ */
603 MODULE = autovivification PACKAGE = autovivification
609 if (!a_initialized++) {
612 a_op_map = ptable_new();
614 MUTEX_INIT(&a_op_map_mutex);
617 PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
619 a_old_ck_padany = PL_check[OP_PADANY];
620 PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_ck_padany);
621 a_old_ck_padsv = PL_check[OP_PADSV];
622 PL_check[OP_PADSV] = MEMBER_TO_FPTR(a_ck_padsv);
624 a_old_ck_aelem = PL_check[OP_AELEM];
625 PL_check[OP_AELEM] = MEMBER_TO_FPTR(a_ck_deref);
626 a_old_ck_helem = PL_check[OP_HELEM];
627 PL_check[OP_HELEM] = MEMBER_TO_FPTR(a_ck_deref);
628 a_old_ck_rv2sv = PL_check[OP_RV2SV];
629 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(a_ck_deref);
631 a_old_ck_rv2av = PL_check[OP_RV2AV];
632 PL_check[OP_RV2AV] = MEMBER_TO_FPTR(a_ck_rv2xv);
633 a_old_ck_rv2hv = PL_check[OP_RV2HV];
634 PL_check[OP_RV2HV] = MEMBER_TO_FPTR(a_ck_rv2xv);
636 a_old_ck_exists = PL_check[OP_EXISTS];
637 PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_ck_root);
638 a_old_ck_delete = PL_check[OP_DELETE];
639 PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_ck_root);
640 a_old_ck_keys = PL_check[OP_KEYS];
641 PL_check[OP_KEYS] = MEMBER_TO_FPTR(a_ck_root);
642 a_old_ck_values = PL_check[OP_VALUES];
643 PL_check[OP_VALUES] = MEMBER_TO_FPTR(a_ck_root);
645 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
646 newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
647 newCONSTSUB(stash, "A_HINT_WARN", newSVuv(A_HINT_WARN));
648 newCONSTSUB(stash, "A_HINT_FETCH", newSVuv(A_HINT_FETCH));
649 newCONSTSUB(stash, "A_HINT_STORE", newSVuv(A_HINT_STORE));
650 newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
651 newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
652 newCONSTSUB(stash, "A_HINT_MASK", newSVuv(A_HINT_MASK));
660 RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
670 RETVAL = newSVuv(a_detag(tag));