This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
48358b564a00174db99a0681fa0fa6370db0c069
[perl5.git] / ext / arybase / arybase.xs
1 #define PERL_NO_GET_CONTEXT     /* we want efficiency */
2 #define PERL_EXT
3 #include "EXTERN.h"
4 #include "perl.h"
5 #include "XSUB.h"
6 #include "feature.h"
7
8 /* ... op => info map ................................................. */
9
10 typedef struct {
11  OP *(*old_pp)(pTHX);
12  IV base;
13 } ab_op_info;
14
15 #define PTABLE_NAME        ptable_map
16 #define PTABLE_VAL_FREE(V) PerlMemShared_free(V)
17 #include "ptable.h"
18 #define ptable_map_store(T, K, V) ptable_map_store(aPTBLMS_ (T), (K), (V))
19
20 STATIC ptable *ab_op_map = NULL;
21
22 #ifdef USE_ITHREADS
23 STATIC perl_mutex ab_op_map_mutex;
24 #endif
25
26 STATIC const ab_op_info *ab_map_fetch(const OP *o, ab_op_info *oi) {
27  const ab_op_info *val;
28
29 #ifdef USE_ITHREADS
30  MUTEX_LOCK(&ab_op_map_mutex);
31 #endif
32
33  val = (ab_op_info *)ptable_fetch(ab_op_map, o);
34  if (val) {
35   *oi = *val;
36   val = oi;
37  }
38
39 #ifdef USE_ITHREADS
40  MUTEX_UNLOCK(&ab_op_map_mutex);
41 #endif
42
43  return val;
44 }
45
46 STATIC const ab_op_info *ab_map_store_locked(
47  pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), IV base
48 ) {
49 #define ab_map_store_locked(O, PP, B) \
50   ab_map_store_locked(aPTBLMS_ (O), (PP), (B))
51  ab_op_info *oi;
52
53  if (!(oi = (ab_op_info *)ptable_fetch(ab_op_map, o))) {
54   oi = (ab_op_info *)PerlMemShared_malloc(sizeof *oi);
55   ptable_map_store(ab_op_map, o, oi);
56  }
57
58  oi->old_pp = old_pp;
59  oi->base   = base;
60  return oi;
61 }
62
63 STATIC void ab_map_store(
64  pPTBLMS_ const OP *o, OP *(*old_pp)(pTHX), IV base)
65 {
66 #define ab_map_store(O, PP, B) ab_map_store(aPTBLMS_ (O),(PP),(B))
67
68 #ifdef USE_ITHREADS
69  MUTEX_LOCK(&ab_op_map_mutex);
70 #endif
71
72  ab_map_store_locked(o, old_pp, base);
73
74 #ifdef USE_ITHREADS
75  MUTEX_UNLOCK(&ab_op_map_mutex);
76 #endif
77 }
78
79 STATIC void ab_map_delete(pTHX_ const OP *o) {
80 #define ab_map_delete(O) ab_map_delete(aTHX_ (O))
81 #ifdef USE_ITHREADS
82  MUTEX_LOCK(&ab_op_map_mutex);
83 #endif
84
85  ptable_map_store(ab_op_map, o, NULL);
86
87 #ifdef USE_ITHREADS
88  MUTEX_UNLOCK(&ab_op_map_mutex);
89 #endif
90 }
91
92 /* ... $[ Implementation .............................................. */
93
94 #define hintkey     "$["
95 #define hintkey_len  (sizeof(hintkey)-1)
96
97 STATIC SV * ab_hint(pTHX_ const bool create) {
98 #define ab_hint(c) ab_hint(aTHX_ c)
99  dVAR;
100  SV **val
101   = hv_fetch(GvHV(PL_hintgv), hintkey, hintkey_len, create);
102  if (!val)
103   return 0;
104  return *val;
105 }
106
107 /* current base at compile time */
108 STATIC IV current_base(pTHX) {
109 #define current_base() current_base(aTHX)
110  SV *hsv = ab_hint(0);
111  assert(FEATURE_ARYBASE_IS_ENABLED);
112  if (!hsv || !SvOK(hsv)) return 0;
113  return SvIV(hsv);
114 }
115
116 STATIC void set_arybase_to(pTHX_ IV base) {
117 #define set_arybase_to(base) set_arybase_to(aTHX_ (base))
118  dVAR;
119  SV *hsv = ab_hint(1);
120  sv_setiv_mg(hsv, base);
121 }
122
123 #define old_ck(opname) STATIC OP *(*ab_old_ck_##opname)(pTHX_ OP *) = 0
124 old_ck(sassign);
125 old_ck(aassign);
126 old_ck(aelem);
127 old_ck(aslice);
128 old_ck(lslice);
129 old_ck(av2arylen);
130 old_ck(splice);
131 old_ck(keys);
132 old_ck(each);
133 old_ck(substr);
134 old_ck(rindex);
135 old_ck(index);
136 old_ck(pos);
137
138 STATIC bool ab_op_is_dollar_bracket(pTHX_ OP *o) {
139 #define ab_op_is_dollar_bracket(o) ab_op_is_dollar_bracket(aTHX_ (o))
140  OP *c;
141  return o->op_type == OP_RV2SV && (o->op_flags & OPf_KIDS)
142   && (c = cUNOPx(o)->op_first)
143   && c->op_type == OP_GV
144   && GvSTASH(cGVOPx_gv(c)) == PL_defstash
145   && strEQ(GvNAME(cGVOPx_gv(c)), "[");
146 }
147
148 STATIC void ab_neuter_dollar_bracket(pTHX_ OP *o) {
149 #define ab_neuter_dollar_bracket(o) ab_neuter_dollar_bracket(aTHX_ (o))
150  OP *oldc, *newc;
151  /*
152   * Must replace the core's $[ with something that can accept assignment
153   * of non-zero value and can be local()ised.  Simplest thing is a
154   * different global variable.
155   */
156  oldc = cUNOPx(o)->op_first;
157  newc = newGVOP(OP_GV, 0,
158    gv_fetchpvs("arybase::leftbrack", GV_ADDMULTI, SVt_PVGV));
159  cUNOPx(o)->op_first = newc;
160  op_free(oldc);
161 }
162
163 STATIC void ab_process_assignment(pTHX_ OP *left, OP *right) {
164 #define ab_process_assignment(l, r) \
165     ab_process_assignment(aTHX_ (l), (r))
166  if (ab_op_is_dollar_bracket(left) && right->op_type == OP_CONST) {
167   set_arybase_to(SvIV(cSVOPx_sv(right)));
168   ab_neuter_dollar_bracket(left);
169   Perl_ck_warner_d(aTHX_
170    packWARN(WARN_DEPRECATED), "Use of assignment to $[ is deprecated"
171   );
172  }
173 }
174
175 STATIC OP *ab_ck_sassign(pTHX_ OP *o) {
176  o = (*ab_old_ck_sassign)(aTHX_ o);
177  if (o->op_type == OP_SASSIGN && FEATURE_ARYBASE_IS_ENABLED) {
178   OP *right = cBINOPx(o)->op_first;
179   OP *left = OP_SIBLING(right);
180   if (left) ab_process_assignment(left, right);
181  }
182  return o;
183 }
184
185 STATIC OP *ab_ck_aassign(pTHX_ OP *o) {
186  o = (*ab_old_ck_aassign)(aTHX_ o);
187  if (o->op_type == OP_AASSIGN && FEATURE_ARYBASE_IS_ENABLED) {
188   OP *right = cBINOPx(o)->op_first;
189   OP *left = OP_SIBLING(right);
190   left = OP_SIBLING(cBINOPx(left)->op_first);
191   right = OP_SIBLING(cBINOPx(right)->op_first);
192   ab_process_assignment(left, right);
193  }
194  return o;
195 }
196
197 void
198 tie(pTHX_ SV * const sv, SV * const obj, HV *const stash)
199 {
200     SV *rv = newSV_type(SVt_RV);
201
202     SvRV_set(rv, obj ? SvREFCNT_inc_simple_NN(obj) : newSV(0));
203     SvROK_on(rv);
204     sv_bless(rv, stash);
205
206     sv_unmagic((SV *)sv, PERL_MAGIC_tiedscalar);
207     sv_magic((SV *)sv, rv, PERL_MAGIC_tiedscalar, NULL, 0);
208     SvREFCNT_dec(rv); /* As sv_magic increased it by one.  */
209 }
210
211 /* This function converts from base-based to 0-based an index to be passed
212    as an argument. */
213 static IV
214 adjust_index(IV index, IV base)
215 {
216  if (index >= base || index > -1) return index-base;
217  return index;
218 }
219 /* This function converts from 0-based to base-based an index to
220    be returned. */
221 static IV
222 adjust_index_r(IV index, IV base)
223 {
224  return index + base;
225 }
226
227 #define replace_sv(sv,base) \
228  ((sv) = sv_2mortal(newSViv(adjust_index(SvIV(sv),base))))
229 #define replace_sv_r(sv,base) \
230  ((sv) = sv_2mortal(newSViv(adjust_index_r(SvIV(sv),base))))
231
232 static OP *ab_pp_basearg(pTHX) {
233  dVAR; dSP;
234  SV **firstp = NULL;
235  SV **svp;
236  UV count = 1;
237  ab_op_info oi;
238  ab_map_fetch(PL_op, &oi);
239  
240  switch (PL_op->op_type) {
241  case OP_AELEM:
242   firstp = SP;
243   break;
244  case OP_ASLICE:
245   firstp = PL_stack_base + TOPMARK + 1;
246   count = SP-firstp;
247   break;
248  case OP_LSLICE:
249   firstp = PL_stack_base + *(PL_markstack_ptr-1)+1;
250   count = TOPMARK - *(PL_markstack_ptr-1);
251   if (GIMME != G_ARRAY) {
252    firstp += count-1;
253    count = 1;
254   }
255   break;
256  case OP_SPLICE:
257   if (SP - PL_stack_base - TOPMARK >= 2)
258    firstp = PL_stack_base + TOPMARK + 2;
259   else count = 0;
260   break;
261  case OP_SUBSTR:
262   firstp = SP-(PL_op->op_private & 7)+2;
263   break;
264  default:
265   DIE(aTHX_
266      "panic: invalid op type for arybase.xs:ab_pp_basearg: %d",
267       PL_op->op_type);
268  }
269  svp = firstp;
270  while (count--) replace_sv(*svp,oi.base), svp++;
271  return (*oi.old_pp)(aTHX);
272 }
273
274 static OP *ab_pp_av2arylen(pTHX) {
275  dSP; dVAR;
276  SV *sv;
277  ab_op_info oi;
278  OP *ret;
279  ab_map_fetch(PL_op, &oi);
280  ret = (*oi.old_pp)(aTHX);
281  if (PL_op->op_flags & OPf_MOD || LVRET) {
282   sv = newSV(0);
283   tie(aTHX_ sv, TOPs, gv_stashpv("arybase::mg",1));
284   SETs(sv);
285  }
286  else {
287   SvGETMAGIC(TOPs);
288   if (SvOK(TOPs)) replace_sv_r(TOPs, oi.base);
289  }
290  return ret;
291 }
292
293 static OP *ab_pp_keys(pTHX) {
294  dVAR; dSP;
295  ab_op_info oi;
296  OP *retval;
297  const I32 offset = SP - PL_stack_base;
298  SV **svp;
299  ab_map_fetch(PL_op, &oi);
300  retval = (*oi.old_pp)(aTHX);
301  if (GIMME_V == G_SCALAR) return retval;
302  SPAGAIN;
303  svp = PL_stack_base + offset;
304  while (svp <= SP) replace_sv_r(*svp,oi.base), ++svp;
305  return retval; 
306 }
307
308 static OP *ab_pp_each(pTHX) {
309  dVAR; dSP;
310  ab_op_info oi;
311  OP *retval;
312  const I32 offset = SP - PL_stack_base;
313  ab_map_fetch(PL_op, &oi);
314  retval = (*oi.old_pp)(aTHX);
315  SPAGAIN;
316  if (GIMME_V == G_SCALAR) {
317   if (SvOK(TOPs)) replace_sv_r(TOPs,oi.base);
318  }
319  else if (offset < SP - PL_stack_base) replace_sv_r(TOPm1s,oi.base);
320  return retval; 
321 }
322
323 static OP *ab_pp_index(pTHX) {
324  dVAR; dSP;
325  ab_op_info oi;
326  OP *retval;
327  ab_map_fetch(PL_op, &oi);
328  if (MAXARG == 3 && TOPs) replace_sv(TOPs,oi.base);
329  retval = (*oi.old_pp)(aTHX);
330  SPAGAIN;
331  replace_sv_r(TOPs,oi.base);
332  return retval; 
333 }
334
335 static OP *ab_ck_base(pTHX_ OP *o)
336 {
337  OP * (*old_ck)(pTHX_ OP *o) = 0;
338  OP * (*new_pp)(pTHX)        = ab_pp_basearg;
339  switch (o->op_type) {
340  case OP_AELEM    : old_ck = ab_old_ck_aelem    ; break;
341  case OP_ASLICE   : old_ck = ab_old_ck_aslice   ; break;
342  case OP_LSLICE   : old_ck = ab_old_ck_lslice   ; break;
343  case OP_AV2ARYLEN: old_ck = ab_old_ck_av2arylen; break;
344  case OP_SPLICE   : old_ck = ab_old_ck_splice   ; break;
345  case OP_KEYS     : old_ck = ab_old_ck_keys     ; break;
346  case OP_EACH     : old_ck = ab_old_ck_each     ; break;
347  case OP_SUBSTR   : old_ck = ab_old_ck_substr   ; break;
348  case OP_RINDEX   : old_ck = ab_old_ck_rindex   ; break;
349  case OP_INDEX    : old_ck = ab_old_ck_index    ; break;
350  case OP_POS      : old_ck = ab_old_ck_pos      ; break;
351  default:
352   DIE(aTHX_
353      "panic: invalid op type for arybase.xs:ab_ck_base: %d",
354       PL_op->op_type);
355  }
356  o = (*old_ck)(aTHX_ o);
357  if (!FEATURE_ARYBASE_IS_ENABLED) return o;
358  /* We need two switch blocks, as the type may have changed. */
359  switch (o->op_type) {
360  case OP_AELEM    :
361  case OP_ASLICE   :
362  case OP_LSLICE   :
363  case OP_SPLICE   :
364  case OP_SUBSTR   : break;
365  case OP_POS      :
366  case OP_AV2ARYLEN: new_pp = ab_pp_av2arylen    ; break;
367  case OP_AKEYS    : new_pp = ab_pp_keys         ; break;
368  case OP_AEACH    : new_pp = ab_pp_each         ; break;
369  case OP_RINDEX   :
370  case OP_INDEX    : new_pp = ab_pp_index        ; break;
371  default: return o;
372  }
373  {
374   IV const base = current_base();
375   if (base) {
376    ab_map_store(o, o->op_ppaddr, base);
377    o->op_ppaddr = new_pp;
378    /* Break the aelemfast optimisation */
379    if (o->op_type == OP_AELEM) {
380     OP *const first = cBINOPo->op_first;
381     if ( OP_SIBLING(first)->op_type == OP_CONST) {
382      OP_SIBLING_set(first, newUNOP(OP_NULL,0,OP_SIBLING(first)));
383     }
384    }
385   }
386   else ab_map_delete(o);
387  }
388  return o;
389 }
390
391
392 STATIC U32 ab_initialized = 0;
393
394 /* --- XS ------------------------------------------------------------- */
395
396 MODULE = arybase        PACKAGE = arybase
397 PROTOTYPES: DISABLE
398
399 BOOT:
400 {
401     GV *const gv = gv_fetchpvn("[", 1, GV_ADDMULTI|GV_NOTQUAL, SVt_PV);
402     sv_unmagic(GvSV(gv), PERL_MAGIC_sv); /* This is *our* scalar now! */
403     tie(aTHX_ GvSV(gv), NULL, GvSTASH(CvGV(cv)));
404
405     if (!ab_initialized++) {
406         ab_op_map = ptable_new();
407 #ifdef USE_ITHREADS
408         MUTEX_INIT(&ab_op_map_mutex);
409 #endif
410 #define check(uc,lc,ck) \
411                 wrap_op_checker(OP_##uc, ab_ck_##ck, &ab_old_ck_##lc)
412         check(SASSIGN,  sassign,  sassign);
413         check(AASSIGN,  aassign,  aassign);
414         check(AELEM,    aelem,    base);
415         check(ASLICE,   aslice,   base);
416         check(LSLICE,   lslice,   base);
417         check(AV2ARYLEN,av2arylen,base);
418         check(SPLICE,   splice,   base);
419         check(KEYS,     keys,     base);
420         check(EACH,     each,     base);
421         check(SUBSTR,   substr,   base);
422         check(RINDEX,   rindex,   base);
423         check(INDEX,    index,    base);
424         check(POS,      pos,      base);
425     }
426 }
427
428 void
429 FETCH(...)
430     PREINIT:
431         SV *ret = FEATURE_ARYBASE_IS_ENABLED
432                    ? cop_hints_fetch_pvs(PL_curcop, "$[", 0)
433                    : 0;
434     PPCODE:
435         if (!ret || !SvOK(ret)) mXPUSHi(0);
436         else XPUSHs(ret);
437
438 void
439 STORE(SV *sv, IV newbase)
440     CODE:
441       PERL_UNUSED_VAR(sv);
442       if (FEATURE_ARYBASE_IS_ENABLED) {
443         SV *base = cop_hints_fetch_pvs(PL_curcop, "$[", 0);
444         if (SvOK(base) ? SvIV(base) == newbase : !newbase) XSRETURN_EMPTY;
445         Perl_croak(aTHX_ "That use of $[ is unsupported");
446       }
447       else if (newbase)
448         Perl_croak(aTHX_ "Assigning non-zero to $[ is no longer possible");
449
450
451 MODULE = arybase        PACKAGE = arybase::mg
452 PROTOTYPES: DISABLE
453
454 void
455 FETCH(SV *sv)
456     PPCODE:
457         if (!SvROK(sv) || SvTYPE(SvRV(sv)) >= SVt_PVAV)
458             Perl_croak(aTHX_ "Not a SCALAR reference");
459         {
460             SV *base = FEATURE_ARYBASE_IS_ENABLED
461                          ? cop_hints_fetch_pvs(PL_curcop, "$[", 0)
462                          : 0;
463             SvGETMAGIC(SvRV(sv));
464             if (!SvOK(SvRV(sv))) XSRETURN_UNDEF;
465             mXPUSHi(adjust_index_r(
466                 SvIV_nomg(SvRV(sv)), base&&SvOK(base)?SvIV(base):0
467             ));
468         }
469
470 void
471 STORE(SV *sv, SV *newbase)
472     CODE:
473         if (!SvROK(sv) || SvTYPE(SvRV(sv)) >= SVt_PVAV)
474             Perl_croak(aTHX_ "Not a SCALAR reference");
475         {
476             SV *base = FEATURE_ARYBASE_IS_ENABLED
477                         ? cop_hints_fetch_pvs(PL_curcop, "$[", 0)
478                         : 0;
479             SvGETMAGIC(newbase);
480             if (!SvOK(newbase)) SvSetMagicSV(SvRV(sv),&PL_sv_undef);
481             else 
482                 sv_setiv_mg(
483                    SvRV(sv),
484                    adjust_index(
485                       SvIV_nomg(newbase), base&&SvOK(base)?SvIV(base):0
486                    )
487                 );
488         }