]> git.vpit.fr Git - perl/modules/autovivification.git/blob - autovivification.xs
Classify aliasing constructs in the "store" category
[perl/modules/autovivification.git] / 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 #define A_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
15
16 #ifndef A_WORKAROUND_REQUIRE_PROPAGATION
17 # define A_WORKAROUND_REQUIRE_PROPAGATION !A_HAS_PERL(5, 10, 1)
18 #endif
19
20 /* --- Helpers ------------------------------------------------------------- */
21
22 #if A_WORKAROUND_REQUIRE_PROPAGATION
23
24 typedef struct {
25  UV  bits;
26  I32 requires;
27 } a_hint_t;
28
29 STATIC SV *a_tag(pTHX_ UV bits) {
30 #define a_tag(B) a_tag(aTHX_ (B))
31  SV *tag;
32  a_hint_t h;
33
34  h.bits = bits;
35
36  {
37   const PERL_SI *si;
38   I32            requires = 0;
39
40   for (si = PL_curstackinfo; si; si = si->si_prev) {
41    I32 cxix;
42
43    for (cxix = si->si_cxix; cxix >= 0; --cxix) {
44     const PERL_CONTEXT *cx = si->si_cxstack + cxix;
45
46     if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE)
47      ++requires;
48    }
49   }
50
51   h.requires = requires;
52  }
53
54  return newSVpvn((const char *) &h, sizeof h);
55 }
56
57 STATIC UV a_detag(pTHX_ const SV *hint) {
58 #define a_detag(H) a_detag(aTHX_ (H))
59  const a_hint_t *h;
60
61  if (!(hint && SvOK(hint)))
62   return 0;
63
64  h = (const a_hint_t *) SvPVX(hint);
65
66  {
67   const PERL_SI *si;
68   I32            requires = 0;
69
70   for (si = PL_curstackinfo; si; si = si->si_prev) {
71    I32 cxix;
72
73    for (cxix = si->si_cxix; cxix >= 0; --cxix) {
74     const PERL_CONTEXT *cx = si->si_cxstack + cxix;
75
76     if (CxTYPE(cx) == CXt_EVAL && cx->blk_eval.old_op_type == OP_REQUIRE
77                                && ++requires > h->requires)
78      return 0;
79    }
80   }
81  }
82
83  return h->bits;
84 }
85
86 #else /* A_WORKAROUND_REQUIRE_PROPAGATION */
87
88 #define a_tag(B)   newSVuv(B)
89 #define a_detag(H) (((H) && SvOK(H)) ? SvUVX(H) : 0)
90
91 #endif /* !A_WORKAROUND_REQUIRE_PROPAGATION */
92
93 /* Used both for hints and op flags */
94 #define A_HINT_STRICT 1
95 #define A_HINT_WARN   2
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)
103
104 /* Only used in op flags */
105 #define A_HINT_DEREF  64
106
107 STATIC U32 a_hash = 0;
108
109 STATIC UV a_hint(pTHX) {
110 #define a_hint() a_hint(aTHX)
111  const SV *hint;
112 #if A_HAS_PERL(5, 9, 5)
113  hint = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
114                                        NULL,
115                                        __PACKAGE__, __PACKAGE_LEN__,
116                                        0,
117                                        a_hash);
118 #else
119  SV **val = hv_fetch(GvHV(PL_hintgv), __PACKAGE__, __PACKAGE_LEN__, a_hash);
120  if (!val)
121   return 0;
122  hint = *val;
123 #endif
124  return a_detag(hint);
125 }
126
127 /* ... op => info map ...................................................... */
128
129 typedef struct {
130  OP *(*old_pp)(pTHX);
131  const OP *root;
132  UV flags;
133 } a_op_info;
134
135 #define PTABLE_NAME        ptable_map
136 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
137
138 #include "ptable.h"
139
140 /* PerlMemShared_free() needs the [ap]PTBLMS_? default values */
141 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
142
143 STATIC ptable *a_op_map = NULL;
144
145 #ifdef USE_ITHREADS
146 STATIC perl_mutex a_op_map_mutex;
147 #endif
148
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))
151  a_op_info *oi;
152
153 #ifdef USE_ITHREADS
154  MUTEX_LOCK(&a_op_map_mutex);
155 #endif
156
157  if (!(oi = ptable_fetch(a_op_map, o))) {
158   oi = PerlMemShared_malloc(sizeof *oi);
159   ptable_map_store(a_op_map, o, oi);
160  }
161
162  oi->old_pp = old_pp;
163  oi->root   = NULL;
164  oi->flags  = flags;
165
166 #ifdef USE_ITHREADS
167  MUTEX_UNLOCK(&a_op_map_mutex);
168 #endif
169 }
170
171 STATIC const a_op_info *a_map_fetch(const OP *o, a_op_info *oi) {
172  const a_op_info *val;
173
174 #ifdef USE_ITHREADS
175  MUTEX_LOCK(&a_op_map_mutex);
176 #endif
177
178  val = ptable_fetch(a_op_map, o);
179  *oi = *val;
180
181 #ifdef USE_ITHREADS
182  MUTEX_UNLOCK(&a_op_map_mutex);
183 #endif
184
185  return val;
186 }
187
188 STATIC void a_map_delete(pTHX_ const OP *o) {
189 #define a_map_delete(O) a_map_delete(aTHX_ (O))
190 #ifdef USE_ITHREADS
191  MUTEX_LOCK(&a_op_map_mutex);
192 #endif
193
194  ptable_map_store(a_op_map, o, NULL);
195
196 #ifdef USE_ITHREADS
197  MUTEX_UNLOCK(&a_op_map_mutex);
198 #endif
199 }
200
201 STATIC void a_map_set_root(const OP *root, UV flags) {
202  a_op_info *oi;
203  const OP *o = root;
204
205 #ifdef USE_ITHREADS
206  MUTEX_LOCK(&a_op_map_mutex);
207 #endif
208
209  while (o) {
210   if (oi = ptable_fetch(a_op_map, o)) {
211    oi->root  = root;
212    oi->flags = flags;
213   }
214   if (!(o->op_flags & OPf_KIDS))
215    break;
216   switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
217    case OA_BASEOP:
218    case OA_UNOP:
219    case OA_BINOP:
220    case OA_BASEOP_OR_UNOP:
221     o = cUNOPo->op_first;
222     break;
223    case OA_LIST:
224    case OA_LISTOP:
225     o = cLISTOPo->op_last;
226     break;
227    default:
228     goto done;
229   }
230  }
231
232 done:
233 #ifdef USE_ITHREADS
234  MUTEX_UNLOCK(&a_op_map_mutex);
235 #endif
236
237  return;
238 }
239
240 /* ... Lightweight pp_defined() ............................................ */
241
242 STATIC bool a_defined(pTHX_ SV *sv) {
243 #define a_defined(S) a_defined(aTHX_ (S))
244  bool defined = FALSE;
245
246  switch (SvTYPE(sv)) {
247   case SVt_PVAV:
248    if (AvMAX(sv) >= 0 || SvGMAGICAL(sv)
249                       || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
250     defined = TRUE;
251    break;
252   case SVt_PVHV:
253    if (HvARRAY(sv) || SvGMAGICAL(sv)
254                    || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
255     defined = TRUE;
256    break;
257   default:
258    defined = SvOK(sv);
259  }
260
261  return defined;
262 }
263
264 /* --- PP functions -------------------------------------------------------- */
265
266 /* ... pp_rv2av ............................................................ */
267
268 STATIC OP *a_pp_rv2av(pTHX) {
269  a_op_info oi;
270  UV hint;
271  dSP;
272
273  a_map_fetch(PL_op, &oi);
274
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
279    * later. */
280   SV *av;
281   POPs;
282   av = sv_2mortal((SV *) newAV());
283   PUSHs(av);
284   RETURN;
285  }
286
287  return CALL_FPTR(oi.old_pp)(aTHX);
288 }
289
290 /* ... pp_rv2hv ............................................................ */
291
292 STATIC OP *a_pp_rv2hv(pTHX) {
293  a_op_info oi;
294  UV hint;
295  dSP;
296
297  a_map_fetch(PL_op, &oi);
298
299  if (PL_op == oi.root) { /* This means "%$hashref" */
300   PL_op->op_ppaddr = oi.old_pp;
301  } else if (!SvOK(TOPs)) {
302   RETURN;
303  }
304
305  return CALL_FPTR(oi.old_pp)(aTHX);
306 }
307
308 /* ... pp_deref (aelem,helem,rv2sv,padsv) .................................. */
309
310 STATIC OP *a_pp_deref(pTHX) {
311  a_op_info oi;
312  UV flags;
313  dSP;
314
315  a_map_fetch(PL_op, &oi);
316  flags = oi.flags;
317
318  if (flags & A_HINT_DEREF) {
319   OP *o;
320   U8 old_private;
321
322 deref:
323   old_private       = PL_op->op_private;
324   PL_op->op_private = ((old_private & ~OPpDEREF) | OPpLVAL_DEFER);
325   o = CALL_FPTR(oi.old_pp)(aTHX);
326   PL_op->op_private = old_private;
327
328   if (flags & (A_HINT_NOTIFY|A_HINT_STORE)) {
329    SPAGAIN;
330    if (!SvOK(TOPs)) {
331     if (flags & A_HINT_STRICT)
332      croak("Reference vivification forbidden");
333     else if (flags & A_HINT_WARN)
334       warn("Reference was vivified");
335     else /* A_HINT_STORE */
336      croak("Can't vivify reference");
337    }
338   }
339
340   return o;
341  } else if (flags && (PL_op->op_private & OPpDEREF || PL_op == oi.root)) {
342   oi.flags = flags & A_HINT_NOTIFY;
343
344   if (oi.root->op_flags & OPf_MOD) {
345    if (flags & A_HINT_STORE)
346     oi.flags |= (A_HINT_STORE|A_HINT_DEREF);
347   } else if (flags & A_HINT_FETCH)
348     oi.flags |= (A_HINT_FETCH|A_HINT_DEREF);
349
350   if (PL_op == oi.root)
351    oi.flags &= ~A_HINT_DEREF;
352
353   /* We will need the updated flags value in the deref part */
354   flags = oi.flags;
355
356   if (flags & A_HINT_DEREF)
357    goto deref;
358
359   /* This op doesn't need to skip autovivification, so restore the original
360    * state. Be aware that another extension might have saved a_pp_deref as the
361    * ppaddr for this op, so restoring PL_op->op_ppaddr doesn't ensure that this
362    * function will never be called again. That's why we don't remove the op info
363    * from our map and we reset oi.flags to 0, so that it can still run correctly
364    * if required. */
365   oi.flags = 0;
366   PL_op->op_ppaddr = oi.old_pp;
367  }
368
369  return CALL_FPTR(oi.old_pp)(aTHX);
370 }
371
372 /* ... pp_root (exists,delete,keys,values) ................................. */
373
374 STATIC OP *a_pp_root_unop(pTHX) {
375  a_op_info oi;
376  dSP;
377
378  if (!a_defined(TOPs)) {
379   POPs;
380   /* Can only be reached by keys or values */
381   if (GIMME_V == G_SCALAR) {
382    dTARGET;
383    PUSHi(0);
384   }
385   RETURN;
386  }
387
388  a_map_fetch(PL_op, &oi);
389
390  return CALL_FPTR(oi.old_pp)(aTHX);
391 }
392
393 STATIC OP *a_pp_root_binop(pTHX) {
394  a_op_info oi;
395  dSP;
396
397  if (!a_defined(TOPm1s)) {
398   POPs;
399   POPs;
400   if (PL_op->op_type == OP_EXISTS)
401    RETPUSHNO;
402   else
403    RETPUSHUNDEF;
404  }
405
406  a_map_fetch(PL_op, &oi);
407
408  return CALL_FPTR(oi.old_pp)(aTHX);
409 }
410
411 /* --- Check functions ----------------------------------------------------- */
412
413 /* ... ck_pad{any,sv} ...................................................... */
414
415 /* Sadly, the PADSV OPs we are interested in don't trigger the padsv check
416  * function, but are instead manually mutated from a PADANY. This is why we set
417  * PL_ppaddr[OP_PADSV] in the padany check function so that PADSV OPs will have
418  * their op_ppaddr set to our pp_padsv. PL_ppaddr[OP_PADSV] is then reset at the
419  * beginning of every ck_pad{any,sv}. Some unwanted OPs can still call our
420  * pp_padsv, but much less than if we would have set PL_ppaddr[OP_PADSV]
421  * globally. */
422
423 STATIC OP *(*a_pp_padsv_saved)(pTHX) = 0;
424
425 STATIC void a_pp_padsv_save(void) {
426  if (a_pp_padsv_saved)
427   return;
428
429  a_pp_padsv_saved    = PL_ppaddr[OP_PADSV];
430  PL_ppaddr[OP_PADSV] = a_pp_deref;
431 }
432
433 STATIC void a_pp_padsv_restore(OP *o) {
434  if (!a_pp_padsv_saved)
435   return;
436
437  if (o->op_ppaddr == a_pp_deref)
438   o->op_ppaddr = a_pp_padsv_saved;
439
440  PL_ppaddr[OP_PADSV] = a_pp_padsv_saved;
441  a_pp_padsv_saved    = 0;
442 }
443
444 STATIC OP *(*a_old_ck_padany)(pTHX_ OP *) = 0;
445
446 STATIC OP *a_ck_padany(pTHX_ OP *o) {
447  UV hint;
448
449  a_pp_padsv_restore(o);
450
451  o = CALL_FPTR(a_old_ck_padany)(aTHX_ o);
452
453  hint = a_hint();
454  if (hint & A_HINT_DO) {
455   a_pp_padsv_save();
456   a_map_store(o, a_pp_padsv_saved, hint);
457  } else
458   a_map_delete(o);
459
460  return o;
461 }
462
463 STATIC OP *(*a_old_ck_padsv)(pTHX_ OP *) = 0;
464
465 STATIC OP *a_ck_padsv(pTHX_ OP *o) {
466  UV hint;
467
468  a_pp_padsv_restore(o);
469
470  o = CALL_FPTR(a_old_ck_padsv)(aTHX_ o);
471
472  hint = a_hint();
473  if (hint & A_HINT_DO) {
474   a_map_store(o, o->op_ppaddr, hint);
475   o->op_ppaddr = a_pp_deref;
476  } else
477   a_map_delete(o);
478
479  return o;
480 }
481
482 /* ... ck_deref (aelem,helem,rv2sv) ........................................ */
483
484 STATIC OP *(*a_old_ck_aelem)(pTHX_ OP *) = 0;
485 STATIC OP *(*a_old_ck_helem)(pTHX_ OP *) = 0;
486 STATIC OP *(*a_old_ck_rv2sv)(pTHX_ OP *) = 0;
487
488 STATIC OP *a_ck_deref(pTHX_ OP *o) {
489  OP * (*old_ck)(pTHX_ OP *o) = 0;
490  UV hint;
491
492  switch (o->op_type) {
493   case OP_AELEM: old_ck = a_old_ck_aelem; break;
494   case OP_HELEM: old_ck = a_old_ck_helem; break;
495   case OP_RV2SV: old_ck = a_old_ck_rv2sv; break;
496  }
497  o = CALL_FPTR(old_ck)(aTHX_ o);
498
499  hint = a_hint();
500  if (hint & A_HINT_DO) {
501   a_map_store(o, o->op_ppaddr, hint);
502   o->op_ppaddr = a_pp_deref;
503   a_map_set_root(o, hint);
504  } else
505   a_map_delete(o);
506
507  return o;
508 }
509
510 /* ... ck_rv2xv (rv2av,rv2hv) .............................................. */
511
512 STATIC OP *(*a_old_ck_rv2av)(pTHX_ OP *) = 0;
513 STATIC OP *(*a_old_ck_rv2hv)(pTHX_ OP *) = 0;
514
515 STATIC OP *a_ck_rv2xv(pTHX_ OP *o) {
516  OP * (*old_ck)(pTHX_ OP *o) = 0;
517  OP * (*new_pp)(pTHX)        = 0;
518  UV hint;
519
520  switch (o->op_type) {
521   case OP_RV2AV: old_ck = a_old_ck_rv2av; new_pp = a_pp_rv2av; break;
522   case OP_RV2HV: old_ck = a_old_ck_rv2hv; new_pp = a_pp_rv2hv; break;
523  }
524  o = CALL_FPTR(old_ck)(aTHX_ o);
525
526  if (cUNOPo->op_first->op_type == OP_GV)
527   return o;
528
529  hint = a_hint();
530  if (hint & A_HINT_DO) {
531   if (!(hint & A_HINT_STRICT)) {
532    a_map_store(o, o->op_ppaddr, hint);
533    o->op_ppaddr = new_pp;
534   }
535   a_map_set_root(o, hint);
536  } else
537   a_map_delete(o);
538
539  return o;
540 }
541
542 /* ... ck_root (exists,delete,keys,values) ................................. */
543
544 STATIC OP *(*a_old_ck_exists)(pTHX_ OP *) = 0;
545 STATIC OP *(*a_old_ck_delete)(pTHX_ OP *) = 0;
546 STATIC OP *(*a_old_ck_keys)  (pTHX_ OP *) = 0;
547 STATIC OP *(*a_old_ck_values)(pTHX_ OP *) = 0;
548
549 STATIC OP *a_ck_root(pTHX_ OP *o) {
550  OP * (*old_ck)(pTHX_ OP *o) = 0;
551  OP * (*new_pp)(pTHX)        = 0;
552  bool enabled = FALSE;
553  UV hint = a_hint();
554
555  switch (o->op_type) {
556   case OP_EXISTS:
557    old_ck  = a_old_ck_exists;
558    new_pp  = a_pp_root_binop;
559    enabled = hint & A_HINT_EXISTS;
560    break;
561   case OP_DELETE:
562    old_ck  = a_old_ck_delete;
563    new_pp  = a_pp_root_binop;
564    enabled = hint & A_HINT_DELETE;
565    break;
566   case OP_KEYS:
567    old_ck  = a_old_ck_keys;
568    new_pp  = a_pp_root_unop;
569    enabled = hint & A_HINT_FETCH;
570    break;
571   case OP_VALUES:
572    old_ck  = a_old_ck_values;
573    new_pp  = a_pp_root_unop;
574    enabled = hint & A_HINT_FETCH;
575    break;
576  }
577  o = CALL_FPTR(old_ck)(aTHX_ o);
578
579  if (hint & A_HINT_DO) {
580   if (enabled) {
581    a_map_set_root(o, hint | A_HINT_DEREF);
582    a_map_store(o, o->op_ppaddr, hint);
583    o->op_ppaddr = new_pp;
584   } else {
585    a_map_set_root(o, 0);
586   }
587  } else
588   a_map_delete(o);
589
590  return o;
591 }
592
593 STATIC U32 a_initialized = 0;
594
595 /* --- XS ------------------------------------------------------------------ */
596
597 MODULE = autovivification      PACKAGE = autovivification
598
599 PROTOTYPES: ENABLE
600
601 BOOT: 
602 {                                    
603  if (!a_initialized++) {
604   HV *stash;
605
606   a_op_map = ptable_new();
607 #ifdef USE_ITHREADS
608   MUTEX_INIT(&a_op_map_mutex);
609 #endif
610
611   PERL_HASH(a_hash, __PACKAGE__, __PACKAGE_LEN__);
612
613   a_old_ck_padany     = PL_check[OP_PADANY];
614   PL_check[OP_PADANY] = MEMBER_TO_FPTR(a_ck_padany);
615   a_old_ck_padsv      = PL_check[OP_PADSV];
616   PL_check[OP_PADSV]  = MEMBER_TO_FPTR(a_ck_padsv);
617
618   a_old_ck_aelem      = PL_check[OP_AELEM];
619   PL_check[OP_AELEM]  = MEMBER_TO_FPTR(a_ck_deref);
620   a_old_ck_helem      = PL_check[OP_HELEM];
621   PL_check[OP_HELEM]  = MEMBER_TO_FPTR(a_ck_deref);
622   a_old_ck_rv2sv      = PL_check[OP_RV2SV];
623   PL_check[OP_RV2SV]  = MEMBER_TO_FPTR(a_ck_deref);
624
625   a_old_ck_rv2av      = PL_check[OP_RV2AV];
626   PL_check[OP_RV2AV]  = MEMBER_TO_FPTR(a_ck_rv2xv);
627   a_old_ck_rv2hv      = PL_check[OP_RV2HV];
628   PL_check[OP_RV2HV]  = MEMBER_TO_FPTR(a_ck_rv2xv);
629
630   a_old_ck_exists     = PL_check[OP_EXISTS];
631   PL_check[OP_EXISTS] = MEMBER_TO_FPTR(a_ck_root);
632   a_old_ck_delete     = PL_check[OP_DELETE];
633   PL_check[OP_DELETE] = MEMBER_TO_FPTR(a_ck_root);
634   a_old_ck_keys       = PL_check[OP_KEYS];
635   PL_check[OP_KEYS]   = MEMBER_TO_FPTR(a_ck_root);
636   a_old_ck_values     = PL_check[OP_VALUES];
637   PL_check[OP_VALUES] = MEMBER_TO_FPTR(a_ck_root);
638
639   stash = gv_stashpvn(__PACKAGE__, __PACKAGE_LEN__, 1);
640   newCONSTSUB(stash, "A_HINT_STRICT", newSVuv(A_HINT_STRICT));
641   newCONSTSUB(stash, "A_HINT_WARN",   newSVuv(A_HINT_WARN));
642   newCONSTSUB(stash, "A_HINT_FETCH",  newSVuv(A_HINT_FETCH));
643   newCONSTSUB(stash, "A_HINT_STORE",  newSVuv(A_HINT_STORE));
644   newCONSTSUB(stash, "A_HINT_EXISTS", newSVuv(A_HINT_EXISTS));
645   newCONSTSUB(stash, "A_HINT_DELETE", newSVuv(A_HINT_DELETE));
646   newCONSTSUB(stash, "A_HINT_MASK",   newSVuv(A_HINT_MASK));
647  }
648 }
649
650 SV *
651 _tag(SV *hint)
652 PROTOTYPE: $
653 CODE:
654  RETVAL = a_tag(SvOK(hint) ? SvUV(hint) : 0);
655 OUTPUT:
656  RETVAL
657
658 SV *
659 _detag(SV *tag)
660 PROTOTYPE: $
661 CODE:
662  if (!SvOK(tag))
663   XSRETURN_UNDEF;
664  RETVAL = newSVuv(a_detag(tag));
665 OUTPUT:
666  RETVAL