]> git.vpit.fr Git - perl/modules/Scope-Upper.git/blob - Upper.xs
Fix segfault when localizing array elements with an invalid negative index
[perl/modules/Scope-Upper.git] / Upper.xs
1 /* This file is part of the Scope::Upper Perl module.
2  * See http://search.cpan.org/dist/Scope-Upper/ */
3
4 #define PERL_NO_GET_CONTEXT
5 #include "EXTERN.h"
6 #include "perl.h" 
7 #include "XSUB.h"
8
9 #ifndef SU_DEBUG
10 # define SU_DEBUG 0
11 #endif
12
13 /* --- Compatibility ------------------------------------------------------- */
14
15 #ifndef STMT_START
16 # define STMT_START do
17 #endif
18
19 #ifndef STMT_END
20 # define STMT_END while (0)
21 #endif
22
23 #if SU_DEBUG
24 # define SU_D(X) STMT_START X STMT_END
25 #else
26 # define SU_D(X)
27 #endif
28
29 #ifndef Newx
30 # define Newx(v, n, c) New(0, v, n, c)
31 #endif
32
33 #ifndef SvPV_const
34 # define SvPV_const(S, L) SvPV(S, L)
35 #endif
36
37 #ifndef SvPV_nolen_const
38 # define SvPV_nolen_const(S) SvPV_nolen(S)
39 #endif
40
41 #ifndef HvNAME_get
42 # define HvNAME_get(H) HvNAME(H)
43 #endif
44
45 #ifndef gv_fetchpvn_flags
46 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
47 #endif
48
49 #ifndef PERL_MAGIC_tied
50 # define PERL_MAGIC_tied 'P'
51 #endif
52
53 #ifndef PERL_MAGIC_env
54 # define PERL_MAGIC_env 'E'
55 #endif
56
57 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
58
59 /* --- Stack manipulations ------------------------------------------------- */
60
61 #ifndef SvCANEXISTDELETE
62 # define SvCANEXISTDELETE(sv) \
63   (!SvRMAGICAL(sv)            \
64    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
65        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
66        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
67        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
68       )                       \
69    )
70 #endif
71
72 /* ... Saving array elements ............................................... */
73
74 #ifndef SAVEADELETE
75
76 typedef struct {
77  AV *av;
78  I32 key;
79 } su_ud_adelete;
80
81 STATIC void su_adelete(pTHX_ void *ud_) {
82  su_ud_adelete *ud = ud_;
83
84  av_delete(ud->av, ud->key, G_DISCARD);
85  SvREFCNT_dec(ud->av);
86
87  Safefree(ud);
88 }
89
90 STATIC void su_save_adelete(pTHX_ AV *av, I32 key) {
91 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
92  su_ud_adelete *ud;
93
94  Newx(ud, 1, su_ud_adelete);
95  ud->av  = av;
96  ud->key = key;
97  SvREFCNT_inc(av);
98
99  SAVEDESTRUCTOR_X(su_adelete, ud);
100 }
101
102 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
103
104 #endif /* SAVEADELETE */
105
106 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
107 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
108  I32 idx = SvIV(key);
109  I32 preeminent = 1;
110  SV **svp;
111  HV *stash;
112  MAGIC *mg;
113
114  if (SvCANEXISTDELETE(av))
115   preeminent = av_exists(av, idx);
116
117  svp = av_fetch(av, idx, 1);
118  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
119
120  if (preeminent)
121   save_aelem(av, idx, svp);
122  else
123   SAVEADELETE(av, idx);
124
125  if (val) { /* local $x[$idx] = $val; */
126   SvSetMagicSV(*svp, val);
127  } else {   /* local $x[$idx]; delete $x[$idx]; */
128   av_delete(av, idx, G_DISCARD);
129  }
130 }
131
132 /* ... Saving hash elements ................................................ */
133
134 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
135 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
136  I32 preeminent = 1;
137  HE *he;
138  SV **svp;
139  HV *stash;
140  MAGIC *mg;
141
142  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
143   preeminent = hv_exists_ent(hv, keysv, 0);
144
145  he  = hv_fetch_ent(hv, keysv, 1, 0);
146  svp = he ? &HeVAL(he) : NULL;
147  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
148
149  if (HvNAME_get(hv) && isGV(*svp)) {
150   save_gp((GV *) *svp, 0);
151   return;
152  }
153
154  if (preeminent)
155   save_helem(hv, keysv, svp);
156  else {
157   STRLEN keylen;
158   const char * const key = SvPV_const(keysv, keylen);
159   SAVEDELETE(hv, savepvn(key, keylen),
160                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
161  }
162
163  if (val) { /* local $x{$keysv} = $val; */
164   SvSetMagicSV(*svp, val);
165  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
166   hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
167  }
168 }
169
170 /* --- Actions ------------------------------------------------------------- */
171
172 typedef struct {
173  I32 depth;
174  I32 *origin;
175  void (*handler)(pTHX_ void *);
176 } su_ud_common;
177
178 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
179 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
180 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
181
182 #define SU_UD_FREE(U) STMT_START { \
183  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
184  Safefree(U); \
185 } STMT_END
186
187 /* ... Reap ................................................................ */
188
189 typedef struct {
190  su_ud_common ci;
191  SV *cb;
192 } su_ud_reap;
193
194 STATIC void su_call(pTHX_ void *ud_) {
195  su_ud_reap *ud = (su_ud_reap *) ud_;
196 #if SU_HAS_PERL(5, 10, 0)
197  I32 dieing = PL_op->op_type == OP_DIE;
198 #endif
199
200  dSP;
201
202  SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
203                                      ud, PL_scopestack_ix, PL_savestack_ix));
204  ENTER;
205  SAVETMPS;
206
207  PUSHMARK(SP);
208  PUTBACK;
209
210  /* If cxstack_ix isn't incremented there, the eval context will be overwritten
211   * when the new sub scope will be created in call_sv. */
212
213 #if SU_HAS_PERL(5, 10, 0)
214  if (dieing)
215   if (cxstack_ix < cxstack_max)
216    ++cxstack_ix;
217   else
218    cxstack_ix = Perl_cxinc(aTHX);
219 #endif
220
221  call_sv(ud->cb, G_VOID);
222
223 #if SU_HAS_PERL(5, 10, 0)
224  if (dieing && cxstack_ix > 0)
225   --cxstack_ix;
226 #endif
227
228  SPAGAIN;
229  PUTBACK;
230
231  FREETMPS;
232  LEAVE;
233
234  SvREFCNT_dec(ud->cb);
235  SU_UD_FREE(ud);
236 }
237
238 STATIC void su_reap(pTHX_ void *ud) {
239 #define su_reap(U) su_reap(aTHX_ (U))
240  SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
241                                      ud, PL_scopestack_ix, PL_savestack_ix));
242  SAVEDESTRUCTOR_X(su_call, ud);
243  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
244                                      ud, PL_savestack_ix,
245                                          PL_scopestack[PL_scopestack_ix]));
246 }
247
248 /* ... Localize & localize array/hash element .............................. */
249
250 typedef struct {
251  su_ud_common ci;
252  SV *sv;
253  SV *val;
254  SV *elem;
255 } su_ud_localize;
256
257 STATIC void su_localize(pTHX_ void *ud_) {
258 #define su_localize(U) su_localize(aTHX_ (U))
259  su_ud_localize *ud = (su_ud_localize *) ud_;
260  SV *sv   = ud->sv;
261  SV *val  = ud->val;
262  SV *elem = ud->elem;
263  GV *gv;
264  UV deref = 0;
265  svtype t = SVt_NULL;
266
267  if (SvTYPE(sv) >= SVt_PVGV) {
268   gv = (GV *) sv;
269   if (!val) {               /* local *x; */
270    t = SVt_PVGV;
271   } else if (!SvROK(val)) { /* local *x = $val; */
272    goto assign;
273   } else {                  /* local *x = \$val; */
274    t = SvTYPE(SvRV(val));
275    deref = 1;
276   }
277  } else {
278   STRLEN len, l;
279   const char *p = SvPV_const(sv, len), *s;
280   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
281   if (!l) {
282    l = len;
283    s = p;
284   }
285   switch (*s) {
286    case '$': t = SVt_PV;   break;
287    case '@': t = SVt_PVAV; break;
288    case '%': t = SVt_PVHV; break;
289    case '&': t = SVt_PVCV; break;
290    case '*': t = SVt_PVGV; break;
291   }
292   if (t != SVt_NULL) {
293    ++s;
294    --l;
295   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
296    if (SvROK(val) && !sv_isobject(val)) {
297     t = SvTYPE(SvRV(val));
298     deref = 1;
299    } else {
300     t = SvTYPE(val);
301    }
302   }
303   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
304  }
305
306  SU_D({
307   SV *z = newSV_type(t);
308   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
309                                  ud, sv_reftype(z, 0),
310                                      PL_scopestack_ix, PL_savestack_ix);
311   SvREFCNT_dec(z);
312  });
313
314  /* Inspired from Alias.pm */
315  switch (t) {
316   case SVt_PVAV:
317    if (elem) {
318     su_save_aelem(GvAV(gv), elem, val);
319     goto done;
320    } else
321     save_ary(gv);
322    break;
323   case SVt_PVHV:
324    if (elem) {
325     su_save_helem(GvHV(gv), elem, val);
326     goto done;
327    } else
328     save_hash(gv);
329    break;
330   case SVt_PVGV:
331    save_gp(gv, 1); /* hide previous entry in symtab */
332    break;
333   case SVt_PVCV:
334    SAVESPTR(GvCV(gv));
335    GvCV(gv) = NULL;
336    break;
337   default:
338    gv = (GV *) save_scalar(gv);
339 maybe_deref:
340    if (deref) /* val != NULL */
341     val = SvRV(val);
342    break;
343  }
344
345  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
346                                      ud, PL_savestack_ix,
347                                          PL_scopestack[PL_scopestack_ix]));
348
349 assign:
350  if (val)
351   SvSetMagicSV((SV *) gv, val);
352
353 done:
354  SvREFCNT_dec(ud->elem);
355  SvREFCNT_dec(ud->val);
356  SvREFCNT_dec(ud->sv);
357  SU_UD_FREE(ud);
358 }
359
360 /* --- Pop a context back -------------------------------------------------- */
361
362 #if SU_DEBUG
363 # ifdef DEBUGGING
364 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
365 # else
366 #  define SU_CXNAME "XXX"
367 # endif
368 #endif
369
370 STATIC void su_pop(pTHX_ void *ud) {
371 #define su_pop(U) su_pop(aTHX_ (U))
372  I32 depth, base, mark, *origin;
373  depth = SU_UD_DEPTH(ud);
374
375  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
376                                      ud, SU_CXNAME,
377                                          PL_scopestack_ix, PL_savestack_ix,
378                                          PL_scopestack[PL_scopestack_ix],
379                                          depth));
380
381  origin = SU_UD_ORIGIN(ud);
382  mark   = origin[depth];
383  base   = origin[depth - 1];
384
385  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
386                                      ud, mark, base));
387
388  if (base < mark) {
389   PL_savestack_ix = mark;
390   leave_scope(base);
391  }
392  PL_savestack_ix = base;
393  if (--depth > 0) {
394   SU_UD_DEPTH(ud) = depth;
395   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
396                                       ud, PL_savestack_ix, depth));
397   SAVEDESTRUCTOR_X(su_pop, ud);
398   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
399                                       ud, PL_savestack_ix, depth));
400  } else {
401   SU_UD_HANDLER(ud)(aTHX_ ud);
402  }
403 }
404
405 /* --- Initialize the stack and the action userdata ------------------------ */
406
407 STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
408 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
409  I32 i, depth = 0, *origin;
410  I32 cur, last, step;
411
412  LEAVE;
413
414  if (level <= 0) {
415   SU_UD_HANDLER(ud)(aTHX_ ud);
416   goto done;
417  }
418
419  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
420
421  for (i = 0; i < level; ++i) {
422   PERL_CONTEXT *cx = &cxstack[cxstack_ix - i];
423   switch (CxTYPE(cx)) {
424 #if SU_HAS_PERL(5, 11, 0)
425    case CXt_LOOP_FOR:
426    case CXt_LOOP_PLAIN:
427    case CXt_LOOP_LAZYSV:
428    case CXt_LOOP_LAZYIV:
429 #else
430    case CXt_LOOP:
431 #endif
432     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
433     depth += 2;
434     break;
435    default:
436     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
437     depth++;
438     break;
439   }
440  }
441  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
442
443  Newx(origin, depth + 1, I32);
444  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
445  PL_scopestack[PL_scopestack_ix - depth] += size;
446  for (i = depth - 1; i >= 1; --i) {
447   I32 j = PL_scopestack_ix - i;
448   origin[depth - i] = PL_scopestack[j];
449   PL_scopestack[j] += 3;
450  }
451  origin[depth] = PL_savestack_ix;
452
453  SU_D({
454   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
455                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
456   for (i = depth - 1; i >= 0; --i) {
457    I32 x = PL_scopestack_ix  - depth + i;
458    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
459                                   i, depth - i, x, PL_scopestack[x], origin[i]);
460   }
461  });
462
463  SU_UD_ORIGIN(ud) = origin;
464  SU_UD_DEPTH(ud)  = depth;
465
466  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
467                                      ud, PL_savestack_ix, depth));
468
469  SAVEDESTRUCTOR_X(su_pop, ud);
470
471 done:
472  ENTER;
473
474  return depth;
475 }
476
477 #define SU_GET_LEVEL(A)  \
478  if (items > A) {        \
479   SV *lsv = ST(A);       \
480   if (SvOK(lsv))         \
481    level = SvUV(lsv);    \
482   if (level < 0)         \
483    XSRETURN(0);          \
484  }                       \
485  if (level > cxstack_ix) \
486   level = cxstack_ix;
487
488 /* --- XS ------------------------------------------------------------------ */
489
490 MODULE = Scope::Upper            PACKAGE = Scope::Upper
491
492 PROTOTYPES: ENABLE
493
494 SV *
495 TOPLEVEL()
496 PROTOTYPE:
497 CODE:
498  RETVAL = newSViv(cxstack_ix);
499 OUTPUT:
500  RETVAL
501
502 void
503 reap(SV *hook, ...)
504 PROTOTYPE: &;$
505 PREINIT:
506  I32 level = 0;
507  su_ud_reap *ud;
508 CODE:
509  SU_GET_LEVEL(1);
510  Newx(ud, 1, su_ud_reap);
511  SU_UD_ORIGIN(ud)  = NULL;
512  SU_UD_HANDLER(ud) = su_reap;
513  ud->cb = newSVsv(hook);
514  su_init(level, ud, 3);
515
516 void
517 localize(SV *sv, SV *val, ...)
518 PROTOTYPE: $$;$
519 PREINIT:
520  I32 level = 0;
521  su_ud_localize *ud;
522 CODE:
523  SU_GET_LEVEL(2);
524  Newx(ud, 1, su_ud_localize);
525  SU_UD_ORIGIN(ud)  = NULL;
526  SU_UD_HANDLER(ud) = su_localize;
527  SvREFCNT_inc(sv);
528  ud->sv   = sv;
529  ud->val  = newSVsv(val);
530  ud->elem = NULL;
531  su_init(level, ud, 3);
532
533 void
534 localize_elem(SV *sv, SV *elem, SV *val, ...)
535 PROTOTYPE: $$$;$
536 PREINIT:
537  I32 level = 0;
538  su_ud_localize *ud;
539 CODE:
540  SU_GET_LEVEL(3);
541  Newx(ud, 1, su_ud_localize);
542  SU_UD_ORIGIN(ud)  = NULL;
543  SU_UD_HANDLER(ud) = su_localize;
544  SvREFCNT_inc(sv);
545  ud->sv   = sv;
546  ud->val  = newSVsv(val);
547  SvREFCNT_inc(elem);
548  ud->elem = elem;
549  su_init(level, ud, 4);
550
551 void
552 localize_delete(SV *sv, SV *elem, ...)
553 PROTOTYPE: $$;$
554 PREINIT:
555  I32 level = 0;
556  su_ud_localize *ud;
557 CODE:
558  SU_GET_LEVEL(2);
559  Newx(ud, 1, su_ud_localize);
560  SU_UD_ORIGIN(ud)  = NULL;
561  SU_UD_HANDLER(ud) = su_localize;
562  SvREFCNT_inc(sv);
563  ud->sv   = sv;
564  ud->val  = NULL;
565  SvREFCNT_inc(elem);
566  ud->elem = elem;
567  su_init(level, ud, 4);