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 #ifndef SvCANEXISTDELETE
 139 # define SvCANEXISTDELETE(sv) \
 140   (!SvRMAGICAL(sv)            \
 141    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 142        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 143        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 144        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 145       )                       \
 146    )
 147 #endif
 148
 149 STATIC I32 su_av_preeminent(pTHX_ AV *av, I32 key) {
 150 #define su_av_preeminent(A, K) su_av_preeminent(aTHX_ (A), (K))
 151  MAGIC *mg;
 152  HV *stash;
 153
 154  if (!av)
 155   return 0;
 156  if (SvCANEXISTDELETE(av))
 157   return av_exists(av, key);
 158
 159  return 1;
 160 }
 161
 162 #ifndef SAVEADELETE
 163
 164 typedef struct {
 165  AV *av;
 166  I32 key;
 167 } su_ud_adelete;
 168
 169 STATIC void su_adelete(pTHX_ void *ud_) {
 170  su_ud_adelete *ud = ud_;
 171
 172  av_delete(ud->av, ud->key, G_DISCARD);
 173  SvREFCNT_dec(ud->av);
 174
 175  Safefree(ud);
 176 }
 177
 178 STATIC void su_save_adelete(pTHX_ AV *av, I32 key) {
 179 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 180  su_ud_adelete *ud;
 181
 182  Newx(ud, 1, su_ud_adelete);
 183  ud->av  = av;
 184  ud->key = key;
 185  SvREFCNT_inc(av);
 186
 187  SAVEDESTRUCTOR_X(su_adelete, ud);
 188 }
 189
 190 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 191
 192 #endif /* SAVEADELETE */
 193
 194 STATIC void su_save_aelem(pTHX_ AV *av, I32 key, SV **svp, I32 preeminent) {
 195 #define su_save_aelem(A, K, S, P) su_save_aelem(aTHX_ (A), (K), (S), (P))
 196  if (preeminent)
 197   save_aelem(av, key, svp);
 198  else
 199   SAVEADELETE(av, key);
 200 }
 201
 202 STATIC I32 su_hv_preeminent(pTHX_ HV *hv, SV *keysv) {
 203 #define su_hv_preeminent(H, K) su_hv_preeminent(aTHX_ (H), (K))
 204  MAGIC *mg;
 205  HV *stash;
 206
 207  if (!hv)
 208   return 0;
 209  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 210   return hv_exists_ent(hv, keysv, 0);
 211
 212  return 1;
 213 }
 214
 215 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV **svp, I32 preeminent) {
 216 #define su_save_helem(H, K, S, P) su_save_helem(aTHX_ (H), (K), (S), (P))
 217  if (HvNAME_get(hv) && isGV(*svp)) {
 218   save_gp((GV *) *svp, 0);
 219   return;
 220  }
 221  if (!preeminent) {
 222   STRLEN keylen;
 223   const char * const key = SvPV_const(keysv, keylen);
 224   SAVEDELETE(hv, savepvn(key, keylen),
 225                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 226  } else {
 227   save_helem(hv, keysv, svp);
 228  }
 229 }
 230
 231 STATIC void su_localize(pTHX_ void *ud_) {
 232 #define su_localize(U) su_localize(aTHX_ (U))
 233  su_ud_localize *ud = (su_ud_localize *) ud_;
 234  SV *sv   = ud->sv;
 235  SV *val  = ud->val;
 236  SV *elem = ud->elem;
 237  GV *gv;
 238  UV deref = 0;
 239  svtype t = SVt_NULL;
 240
 241  if (SvTYPE(sv) >= SVt_PVGV) {
 242   gv = (GV *) sv;
 243   if (!SvROK(val))
 244    goto assign;
 245   t = SvTYPE(SvRV(val));
 246   deref = 1;
 247  } else {
 248   STRLEN len, l;
 249   const char *p = SvPV_const(sv, len), *s;
 250   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 251   if (!l) {
 252    l = len;
 253    s = p;
 254   }
 255   switch (*s) {
 256    case '$': t = SVt_PV;   break;
 257    case '@': t = SVt_PVAV; break;
 258    case '%': t = SVt_PVHV; break;
 259    case '&': t = SVt_PVCV; break;
 260    case '*': t = SVt_PVGV; break;
 261   }
 262   if (t == SVt_NULL) {
 263    if (SvROK(val) && !sv_isobject(val)) {
 264     t = SvTYPE(SvRV(val));
 265     deref = 1;
 266    } else {
 267     t = SvTYPE(val);
 268    }
 269   } else {
 270    ++s;
 271    --l;
 272   }
 273   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
 274  }
 275
 276  SU_D({
 277   SV *z = newSV_type(t);
 278   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
 279                                  ud, sv_reftype(z, 0),
 280                                      PL_scopestack_ix, PL_savestack_ix);
 281   SvREFCNT_dec(z);
 282  });
 283
 284  /* Inspired from Alias.pm */
 285  switch (t) {
 286   case SVt_PVAV:
 287    if (elem) {
 288     I32 idx  = SvIV(elem);
 289     AV *av   = GvAV(gv);
 290     I32 preeminent = su_av_preeminent(av, idx);
 291     SV **svp = av_fetch(av, idx, 1);
 292     if (!*svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 293     su_save_aelem(av, idx, svp, preeminent);
 294     gv = (GV *) *svp;
 295     goto maybe_deref;
 296    } else
 297     save_ary(gv);
 298    break;
 299   case SVt_PVHV:
 300    if (elem) {
 301     HV *hv   = GvHV(gv);
 302     I32 preeminent = su_hv_preeminent(hv, elem);
 303     HE *he   = hv_fetch_ent(hv, elem, 1, 0);
 304     SV **svp = he ? &HeVAL(he) : NULL;
 305     if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 306     su_save_helem(hv, elem, svp, preeminent);
 307     gv = (GV *) *svp;
 308     goto maybe_deref;
 309    } else
 310     save_hash(gv);
 311    break;
 312   case SVt_PVGV:
 313    save_gp(gv, 1); /* hide previous entry in symtab */
 314    break;
 315   case SVt_PVCV:
 316    SAVESPTR(GvCV(gv));
 317    GvCV(gv) = NULL;
 318    break;
 319   default:
 320    gv = (GV *) save_scalar(gv);
 321 maybe_deref:
 322    if (deref)
 323     val = SvRV(val);
 324    break;
 325  }
 326
 327  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 328                                      ud, PL_savestack_ix,
 329                                          PL_scopestack[PL_scopestack_ix]));
 330
 331 assign:
 332  SvSetMagicSV((SV *) gv, val);
 333
 334  SvREFCNT_dec(ud->elem);
 335  SvREFCNT_dec(ud->val);
 336  SvREFCNT_dec(ud->sv);
 337  SU_UD_FREE(ud);
 338 }
 339
 340 #if SU_DEBUG
 341 # ifdef DEBUGGING
 342 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 343 # else
 344 #  define SU_CXNAME "XXX"
 345 # endif
 346 #endif
 347
 348 STATIC void su_pop(pTHX_ void *ud) {
 349 #define su_pop(U) su_pop(aTHX_ (U))
 350  I32 depth, base, mark, *origin;
 351  depth = SU_UD_DEPTH(ud);
 352
 353  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
 354                                      ud, SU_CXNAME,
 355                                          PL_scopestack_ix, PL_savestack_ix,
 356                                          PL_scopestack[PL_scopestack_ix],
 357                                          depth));
 358
 359  origin = SU_UD_ORIGIN(ud);
 360  mark   = origin[depth];
 361  base   = origin[depth - 1];
 362
 363  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
 364                                      ud, mark, base));
 365
 366  if (base < mark) {
 367   PL_savestack_ix = mark;
 368   leave_scope(base);
 369  }
 370  PL_savestack_ix = base;
 371  if (--depth > 0) {
 372   SU_UD_DEPTH(ud) = depth;
 373   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
 374                                       ud, PL_savestack_ix, depth));
 375   SAVEDESTRUCTOR_X(su_pop, ud);
 376   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
 377                                       ud, PL_savestack_ix, depth));
 378  } else {
 379   SU_UD_HANDLER(ud)(aTHX_ ud);
 380  }
 381 }
 382
 383 STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
 384 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 385  I32 i, depth = 0, *origin;
 386  I32 cur, last, step;
 387
 388  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
 389
 390  for (i = 0; i < level; ++i) {
 391   PERL_CONTEXT *cx = &cxstack[cxstack_ix - i];
 392   switch (CxTYPE(cx)) {
 393 #if SU_HAS_PERL(5, 11, 0)
 394    case CXt_LOOP_FOR:
 395    case CXt_LOOP_PLAIN:
 396    case CXt_LOOP_LAZYSV:
 397    case CXt_LOOP_LAZYIV:
 398 #else
 399    case CXt_LOOP:
 400 #endif
 401     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 402     depth += 2;
 403     break;
 404    default:
 405     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
 406     depth++;
 407     break;
 408   }
 409  }
 410  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 411
 412  Newx(origin, depth + 1, I32);
 413  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 414  PL_scopestack[PL_scopestack_ix - depth] += size;
 415  for (i = depth - 1; i >= 1; --i) {
 416   I32 j = PL_scopestack_ix - i;
 417   origin[depth - i] = PL_scopestack[j];
 418   PL_scopestack[j] += 3;
 419  }
 420  origin[depth] = PL_savestack_ix;
 421
 422  SU_D({
 423   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 424                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
 425   for (i = depth - 1; i >= 0; --i) {
 426    I32 x = PL_scopestack_ix  - depth + i;
 427    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 428                                   i, depth - i, x, PL_scopestack[x], origin[i]);
 429   }
 430  });
 431
 432  SU_UD_ORIGIN(ud) = origin;
 433  SU_UD_DEPTH(ud)  = depth;
 434  return depth;
 435 }
 436
 437 #define SU_GET_LEVEL(A)  \
 438  if (items > A) {        \
 439   SV *lsv = ST(A);       \
 440   if (SvOK(lsv))         \
 441    level = SvUV(lsv);    \
 442   if (level < 0)         \
 443    XSRETURN(0);          \
 444  }                       \
 445  if (level > cxstack_ix) \
 446   level = cxstack_ix;
 447
 448 /* --- XS ------------------------------------------------------------------ */
 449
 450 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 451
 452 PROTOTYPES: ENABLE
 453
 454 SV *
 455 TOPLEVEL()
 456 PROTOTYPE:
 457 CODE:
 458  RETVAL = newSViv(cxstack_ix);
 459 OUTPUT:
 460  RETVAL
 461
 462 void
 463 reap(SV *hook, ...)
 464 PROTOTYPE: &;$
 465 PREINIT:
 466  I32 level = 0;
 467  su_ud_reap *ud;
 468 CODE:
 469  SU_GET_LEVEL(1);
 470  Newx(ud, 1, su_ud_reap);
 471  SU_UD_ORIGIN(ud)  = NULL;
 472  SU_UD_HANDLER(ud) = su_reap;
 473  ud->cb = newSVsv(hook);
 474  LEAVE;
 475  if (level) {
 476   I32 depth = su_init(level, ud, 3);
 477   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 478                                       ud, PL_savestack_ix, depth));
 479   SAVEDESTRUCTOR_X(su_pop, ud);
 480  } else
 481   su_reap(ud);
 482  ENTER;
 483
 484 void
 485 localize(SV *sv, SV *val, ...)
 486 PROTOTYPE: $$;$
 487 PREINIT:
 488  I32 level = 0;
 489  su_ud_localize *ud;
 490 CODE:
 491  SU_GET_LEVEL(2);
 492  Newx(ud, 1, su_ud_localize);
 493  SU_UD_ORIGIN(ud)  = NULL;
 494  SU_UD_HANDLER(ud) = su_localize;
 495  SvREFCNT_inc(sv);
 496  ud->sv   = sv;
 497  ud->val  = newSVsv(val);
 498  ud->elem = NULL;
 499  LEAVE;
 500  if (level) {
 501   I32 depth = su_init(level, ud, 3);
 502   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 503                                       ud, PL_savestack_ix, depth));
 504   SAVEDESTRUCTOR_X(su_pop, ud);
 505  } else
 506   su_localize(ud);
 507  ENTER;
 508
 509 void
 510 localize_elem(SV *sv, SV *elem, SV *val, ...)
 511 PROTOTYPE: $$$;$
 512 PREINIT:
 513  I32 level = 0;
 514  su_ud_localize *ud;
 515 CODE:
 516  SU_GET_LEVEL(3);
 517  Newx(ud, 1, su_ud_localize);
 518  SU_UD_ORIGIN(ud)  = NULL;
 519  SU_UD_HANDLER(ud) = su_localize;
 520  SvREFCNT_inc(sv);
 521  ud->sv   = sv;
 522  ud->val  = newSVsv(val);
 523  SvREFCNT_inc(elem);
 524  ud->elem = elem;
 525  LEAVE;
 526  if (level) {
 527   I32 depth = su_init(level, ud, 4);
 528   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 529                                       ud, PL_savestack_ix, depth));
 530   SAVEDESTRUCTOR_X(su_pop, ud);
 531  } else
 532   su_localize(ud);
 533  ENTER;
 534