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