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);
186 MUTEX_UNLOCK(&a_op_map_mutex);
192 STATIC void a_map_delete(pTHX_ const OP *o) {
193 #define a_map_delete(O) a_map_delete(aTHX_ (O))
195 MUTEX_LOCK(&a_op_map_mutex);
198 ptable_map_store(a_op_map, o, NULL);
201 MUTEX_UNLOCK(&a_op_map_mutex);
205 STATIC void a_map_set_root(const OP *root, UV flags) {
210 MUTEX_LOCK(&a_op_map_mutex);
214 if (oi = ptable_fetch(a_op_map, o)) {
218 if (!(o->op_flags & OPf_KIDS))
220 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
224 case OA_BASEOP_OR_UNOP:
225 o = cUNOPo->op_first;
229 o = cLISTOPo->op_last;
238 MUTEX_UNLOCK(&a_op_map_mutex);
244 /* ... Lightweight pp_defined() ............................................ */
246 STATIC bool a_defined(pTHX_ SV *sv) {
247 #define a_defined(S) a_defined(aTHX_ (S))
248 bool defined = FALSE;
250 switch (SvTYPE(sv)) {
252 if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
253 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
257 if (HvARRAY(sv) || SvGMAGICAL(sv)
258 || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
268 /* --- PP functions -------------------------------------------------------- */
270 /* ... pp_rv2av ............................................................ */
272 STATIC OP *a_pp_rv2av(pTHX) {
278 /* We always need to push an empty array to fool the pp_aelem() that comes
282 av = sv_2mortal((SV *) newAV());
287 a_map_fetch(PL_op, &oi);
289 return CALL_FPTR(oi.old_pp)(aTHX);
292 /* ... pp_rv2hv ............................................................ */
294 STATIC OP *a_pp_rv2hv(pTHX) {
299 a_map_fetch(PL_op, &oi);
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 const char a_msg_forbidden[] = "Reference vivification forbidden";
317 STATIC const char a_msg_impossible[] = "Can't vivify reference";
319 STATIC OP *a_pp_deref(pTHX) {
324 a_map_fetch(PL_op, &oi);
327 if (flags & A_HINT_DEREF) {
332 old_private = PL_op->op_private;
333 PL_op->op_private = ((old_private & ~OPpDEREF) | OPpLVAL_DEFER);
334 o = CALL_FPTR(oi.old_pp)(aTHX);
335 PL_op->op_private = old_private;
337 if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
340 if (flags & A_HINT_STRICT)
341 croak(a_msg_forbidden);
342 else if (flags & A_HINT_WARN)
343 warn(a_msg_forbidden);
344 else /* A_HINT_STORE */
345 croak(a_msg_impossible);
350 } else if (flags && (PL_op->op_private & OPpDEREF || PL_op == oi.root)) {
351 oi.flags = flags & A_HINT_NOTIFY;
353 if ((oi.root->op_flags & (OPf_MOD|OPf_REF)) != (OPf_MOD|OPf_REF)) {
354 if (flags & A_HINT_FETCH)
355 oi.flags |= (A_HINT_FETCH|A_HINT_DEREF);
356 } else if (flags & A_HINT_STORE)
357 oi.flags |= (A_HINT_STORE|A_HINT_DEREF);
359 if (PL_op == oi.root)
360 oi.flags &= ~A_HINT_DEREF;
362 /* We will need the updated flags value in the deref part */
365 if (flags & A_HINT_DEREF)
368 /* This op doesn't need to skip autovivification, so restore the original
369 * state. Be aware that another extension might have saved a_pp_deref as the
370 * ppaddr for this op, so restoring PL_op->op_ppaddr doesn't ensure that this
371 * function will never be called again. That's why we don't remove the op info
372 * from our map and we reset oi.flags to 0, so that it can still run correctly
375 PL_op->op_ppaddr = oi.old_pp;
378 return CALL_FPTR(oi.old_pp)(aTHX);
381 /* ... pp_root (exists,delete) ............................................. */
383 STATIC OP *a_pp_root(pTHX) {
387 if (!a_defined(TOPm1s)) {
390 if (PL_op->op_type == OP_EXISTS)
396 a_map_fetch(PL_op, &oi);
398 return CALL_FPTR(oi.old_pp)(aTHX);
401 /* --- Check functions ----------------------------------------------------- */
403 /* ... ck_pad{any,sv} ...................................................... */
405 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
406 * function, but are instead manually mutated from a PADANY. This is why we set
407 * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
408 * their op_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
409 * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
410 * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
413 STATIC OP *(*a_pp_padsv_saved)(pTHX) = 0;
415 STATIC void a_pp_padsv_save(void) {
416 if (a_pp_padsv_saved)
419 a_pp_padsv_saved = PL_ppaddr[OP_PADSV];
420 PL_ppaddr[OP_PADSV] = a_pp_deref;
423 STATIC void a_pp_padsv_restore(OP *o) {
424 if (!a_pp_padsv_saved)
427 if (o->op_ppaddr == a_pp_deref)
428 o->op_ppaddr = a_pp_padsv_saved;
430 PL_ppaddr[OP_PADSV] = a_pp_padsv_saved;
431 a_pp_padsv_saved = 0;
434 STATIC OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
436 STATIC OP *a_ck_padany(pTHX_ OP *o) {
439 a_pp_padsv_restore(o);
441 o = CALL_FPTR(a_old_ck_padany)(aTHX_ o);
444 if (hint & A_HINT_DO) {
446 a_map_store(o, a_pp_padsv_saved, hint);
453 STATIC OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
455 STATIC OP *a_ck_padsv(pTHX_ OP *o) {
458 a_pp_padsv_restore(o);
460 o = CALL_FPTR(a_old_ck_padsv)(aTHX_ o);
463 if (hint & A_HINT_DO) {
464 a_map_store(o, o->op_ppaddr, hint);
465 o->op_ppaddr = a_pp_deref;
472 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
474 STATIC OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
475 STATIC OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
476 STATIC OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
478 STATIC OP *a_ck_deref(pTHX_ OP *o) {
479 OP * (*old_ck)(pTHX_ OP *o) = 0;
482 switch (o->op_type) {
483 case OP_AELEM: old_ck = a_old_ck_aelem; break;
484 case OP_HELEM: old_ck = a_old_ck_helem; break;
485 case OP_RV2SV: old_ck = a_old_ck_rv2sv; break;
487 o = CALL_FPTR(old_ck)(aTHX_ o);
490 if (hint & A_HINT_DO) {
491 a_map_store(o, o->op_ppaddr, hint);
492 o->op_ppaddr = a_pp_deref;
493 a_map_set_root(o, hint);
500 /* ... ck_rv2xv (rv2av,rv2hv) .............................................. */
502 STATIC OP *(*a_old_ck_rv2av)(pTHX_ OP *) = 0;
503 STATIC OP *(*a_old_ck_rv2hv)(pTHX_ OP *) = 0;
505 STATIC OP *a_ck_rv2xv(pTHX_ OP *o) {
506 OP * (*old_ck)(pTHX_ OP *o) = 0;
507 OP * (*new_pp)(pTHX) = 0;
510 switch (o->op_type) {
511 case OP_RV2AV: old_ck = a_old_ck_rv2av; new_pp = a_pp_rv2av; break;
512 case OP_RV2HV: old_ck = a_old_ck_rv2hv; new_pp = a_pp_rv2hv; break;
514 o = CALL_FPTR(old_ck)(aTHX_ o);
517 if (hint & A_HINT_DO) {
518 if (!(hint & A_HINT_STRICT)) {
519 a_map_store(o, o->op_ppaddr, hint);
520 o->op_ppaddr = new_pp;
522 a_map_set_root(o, hint);
529 /* ... ck_root (exists,delete) ............................................. */
531 STATIC OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
532 STATIC OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
534 STATIC OP *a_ck_root(pTHX_ OP *o) {
535 OP * (*old_ck)(pTHX_ OP *o) = 0;
536 bool enabled = FALSE;
539 switch (o->op_type) {
541 old_ck = a_old_ck_exists;
542 enabled = hint & A_HINT_EXISTS;
545 old_ck = a_old_ck_delete;
546 enabled = hint & A_HINT_DELETE;
549 o = CALL_FPTR(old_ck)(aTHX_ o);
552 a_map_set_root(o, hint | A_HINT_DEREF);
553 a_map_store(o, o->op_ppaddr, hint);
554 o->op_ppaddr = a_pp_root;
556 a_map_set_root(o, 0);
562 STATIC U32 a_initialized = 0;
564 /* --- XS ------------------------------------------------------------------ */
566 MODULE = autovivification PACKAGE = autovivification
572 if (!a_initialized++) {
575 a_op_map = ptable_new();
577 MUTEX_INIT(&a_op_map_mutex);
580 PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
582 a_old_ck_padany = PL_check[OP_PADANY];
583 PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_ck_padany);
584 a_old_ck_padsv = PL_check[OP_PADSV];
585 PL_check[OP_PADSV] = MEMBER_TO_FPTR(a_ck_padsv);
586 a_old_ck_aelem = PL_check[OP_AELEM];
587 PL_check[OP_AELEM] = MEMBER_TO_FPTR(a_ck_deref);
588 a_old_ck_helem = PL_check[OP_HELEM];
589 PL_check[OP_HELEM] = MEMBER_TO_FPTR(a_ck_deref);
590 a_old_ck_rv2sv = PL_check[OP_RV2SV];
591 PL_check[OP_RV2SV] = MEMBER_TO_FPTR(a_ck_deref);
592 a_old_ck_rv2av = PL_check[OP_RV2AV];
593 PL_check[OP_RV2AV] = MEMBER_TO_FPTR(a_ck_rv2xv);
594 a_old_ck_rv2hv = PL_check[OP_RV2HV];
595 PL_check[OP_RV2HV] = MEMBER_TO_FPTR(a_ck_rv2xv);
596 a_old_ck_exists = PL_check[OP_EXISTS];
597 PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_ck_root);
598 a_old_ck_delete = PL_check[OP_DELETE];
599 PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_ck_root);
601 stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
602 newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
603 newCONSTSUB(stash, "A_HINT_WARN", newSVuv(A_HINT_WARN));
604 newCONSTSUB(stash, "A_HINT_FETCH", newSVuv(A_HINT_FETCH));
605 newCONSTSUB(stash, "A_HINT_STORE", newSVuv(A_HINT_STORE));
606 newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
607 newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
608 newCONSTSUB(stash, "A_HINT_MASK", newSVuv(A_HINT_MASK));
616 RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
626 RETVAL = newSVuv(a_detag(tag));