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 #define __PACKAGE__ "Scope::Upper"
  10
  11 #ifndef SU_DEBUG
  12 # define SU_DEBUG 0
  13 #endif
  14
  15 /* --- Compatibility ------------------------------------------------------- */
  16
  17 #ifndef PERL_UNUSED_VAR
  18 # define PERL_UNUSED_VAR(V)
  19 #endif
  20
  21 #ifndef STMT_START
  22 # define STMT_START do
  23 #endif
  24
  25 #ifndef STMT_END
  26 # define STMT_END while (0)
  27 #endif
  28
  29 #if SU_DEBUG
  30 # define SU_D(X) STMT_START X STMT_END
  31 #else
  32 # define SU_D(X)
  33 #endif
  34
  35 #ifndef Newx
  36 # define Newx(v, n, c) New(0, v, n, c)
  37 #endif
  38
  39 #ifndef SvPV_const
  40 # define SvPV_const(S, L) SvPV(S, L)
  41 #endif
  42
  43 #ifndef SvPV_nolen_const
  44 # define SvPV_nolen_const(S) SvPV_nolen(S)
  45 #endif
  46
  47 #ifndef HvNAME_get
  48 # define HvNAME_get(H) HvNAME(H)
  49 #endif
  50
  51 #ifndef ENTER_with_name
  52 # define ENTER_with_name(N) ENTER
  53 #endif
  54
  55 #ifndef LEAVE_with_name
  56 # define LEAVE_with_name(N) LEAVE
  57 #endif
  58
  59 #ifndef gv_fetchpvn_flags
  60 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
  61 #endif
  62
  63 #ifndef PERL_MAGIC_tied
  64 # define PERL_MAGIC_tied 'P'
  65 #endif
  66
  67 #ifndef PERL_MAGIC_env
  68 # define PERL_MAGIC_env 'E'
  69 #endif
  70
  71 #ifndef NEGATIVE_INDICES_VAR
  72 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
  73 #endif
  74
  75 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  76
  77 /* --- Threads and multiplicity -------------------------------------------- */
  78
  79 #ifndef NOOP
  80 # define NOOP
  81 #endif
  82
  83 #ifndef dNOOP
  84 # define dNOOP
  85 #endif
  86
  87 #ifndef SU_MULTIPLICITY
  88 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  89 #  define SU_MULTIPLICITY 1
  90 # else
  91 #  define SU_MULTIPLICITY 0
  92 # endif
  93 #endif
  94 #if SU_MULTIPLICITY && !defined(tTHX)
  95 # define tTHX PerlInterpreter*
  96 #endif
  97
  98 #if SU_MULTIPLICITY && defined(USE_ITHREADS) && defined(dMY_CXT) && defined(MY_CXT) && defined(START_MY_CXT) && defined(MY_CXT_INIT) && (defined(MY_CXT_CLONE) || defined(dMY_CXT_SV))
  99 # define SU_THREADSAFE 1
 100 # ifndef MY_CXT_CLONE
 101 #  define MY_CXT_CLONE \
 102     dMY_CXT_SV;                                                      \
 103     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
 104     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
 105     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
 106 # endif
 107 #else
 108 # define SU_THREADSAFE 0
 109 # undef  dMY_CXT
 110 # define dMY_CXT      dNOOP
 111 # undef  MY_CXT
 112 # define MY_CXT       su_globaldata
 113 # undef  START_MY_CXT
 114 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
 115 # undef  MY_CXT_INIT
 116 # define MY_CXT_INIT  NOOP
 117 # undef  MY_CXT_CLONE
 118 # define MY_CXT_CLONE NOOP
 119 #endif
 120
 121 /* --- Stack manipulations ------------------------------------------------- */
 122
 123 #ifndef SvCANEXISTDELETE
 124 # define SvCANEXISTDELETE(sv) \
 125   (!SvRMAGICAL(sv)            \
 126    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 127        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 128        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 129        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 130       )                       \
 131    )
 132 #endif
 133
 134 /* ... Saving array elements ............................................... */
 135
 136 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
 137 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
 138  I32 idx;
 139
 140  if (key >= 0)
 141   return key;
 142
 143 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
 144 #if SU_HAS_PERL(5, 8, 1)
 145  if (SvRMAGICAL(av)) {
 146   const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
 147   if (tied_magic) {
 148    SV * const * const negative_indices_glob =
 149                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
 150                              NEGATIVE_INDICES_VAR, 16, 0);
 151    if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
 152     return key;
 153   }
 154  }
 155 #endif
 156
 157  idx = key + av_len(av) + 1;
 158  if (idx < 0)
 159   return key;
 160
 161  return idx;
 162 }
 163
 164 #ifndef SAVEADELETE
 165
 166 typedef struct {
 167  AV *av;
 168  I32 idx;
 169 } su_ud_adelete;
 170
 171 STATIC void su_adelete(pTHX_ void *ud_) {
 172  su_ud_adelete *ud = (su_ud_adelete *) ud_;
 173
 174  av_delete(ud->av, ud->idx, G_DISCARD);
 175  SvREFCNT_dec(ud->av);
 176
 177  Safefree(ud);
 178 }
 179
 180 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
 181 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 182  su_ud_adelete *ud;
 183
 184  Newx(ud, 1, su_ud_adelete);
 185  ud->av  = av;
 186  ud->idx = idx;
 187  SvREFCNT_inc(av);
 188
 189  SAVEDESTRUCTOR_X(su_adelete, ud);
 190 }
 191
 192 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 193
 194 #endif /* SAVEADELETE */
 195
 196 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 197 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 198  I32 idx;
 199  I32 preeminent = 1;
 200  SV **svp;
 201  HV *stash;
 202  MAGIC *mg;
 203
 204  idx = su_av_key2idx(av, SvIV(key));
 205
 206  if (SvCANEXISTDELETE(av))
 207   preeminent = av_exists(av, idx);
 208
 209  svp = av_fetch(av, idx, 1);
 210  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 211
 212  if (preeminent)
 213   save_aelem(av, idx, svp);
 214  else
 215   SAVEADELETE(av, idx);
 216
 217  if (val) { /* local $x[$idx] = $val; */
 218   SvSetMagicSV(*svp, val);
 219  } else {   /* local $x[$idx]; delete $x[$idx]; */
 220   av_delete(av, idx, G_DISCARD);
 221  }
 222 }
 223
 224 /* ... Saving hash elements ................................................ */
 225
 226 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 227 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 228  I32 preeminent = 1;
 229  HE *he;
 230  SV **svp;
 231  HV *stash;
 232  MAGIC *mg;
 233
 234  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 235   preeminent = hv_exists_ent(hv, keysv, 0);
 236
 237  he  = hv_fetch_ent(hv, keysv, 1, 0);
 238  svp = he ? &HeVAL(he) : NULL;
 239  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 240
 241  if (HvNAME_get(hv) && isGV(*svp)) {
 242   save_gp((GV *) *svp, 0);
 243   return;
 244  }
 245
 246  if (preeminent)
 247   save_helem(hv, keysv, svp);
 248  else {
 249   STRLEN keylen;
 250   const char * const key = SvPV_const(keysv, keylen);
 251   SAVEDELETE(hv, savepvn(key, keylen),
 252                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 253  }
 254
 255  if (val) { /* local $x{$keysv} = $val; */
 256   SvSetMagicSV(*svp, val);
 257  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 258   (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 259  }
 260 }
 261
 262 /* --- Actions ------------------------------------------------------------- */
 263
 264 typedef struct {
 265  I32 depth;
 266  I32 *origin;
 267  void (*handler)(pTHX_ void *);
 268 } su_ud_common;
 269
 270 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 271 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 272 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 273
 274 #define SU_UD_FREE(U) STMT_START { \
 275  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 276  Safefree(U); \
 277 } STMT_END
 278
 279 /* ... Reap ................................................................ */
 280
 281 typedef struct {
 282  su_ud_common ci;
 283  SV *cb;
 284 } su_ud_reap;
 285
 286 STATIC void su_call(pTHX_ void *ud_) {
 287  su_ud_reap *ud = (su_ud_reap *) ud_;
 288 #if SU_HAS_PERL(5, 9, 5)
 289  PERL_CONTEXT saved_cx;
 290  I32 dieing = PL_op->op_type == OP_DIE;
 291  I32 cxix;
 292 #endif
 293
 294  dSP;
 295
 296  SU_D({
 297   PerlIO_printf(Perl_debug_log,
 298                 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 299                  ud,           ud, PL_scopestack_ix, PL_savestack_ix);
 300  });
 301
 302  ENTER;
 303  SAVETMPS;
 304
 305  PUSHMARK(SP);
 306  PUTBACK;
 307
 308  /* If the recently popped context isn't saved there, it will be overwritten by
 309   * the sub scope from call_sv, although it's still needed in our caller. */
 310
 311 #if SU_HAS_PERL(5, 9, 5)
 312  if (dieing) {
 313   if (cxstack_ix < cxstack_max)
 314    cxix = cxstack_ix + 1;
 315   else
 316    cxix = Perl_cxinc(aTHX);
 317   saved_cx = cxstack[cxix];
 318  }
 319 #endif
 320
 321  call_sv(ud->cb, G_VOID);
 322
 323 #if SU_HAS_PERL(5, 9, 5)
 324  if (dieing)
 325   cxstack[cxix] = saved_cx;
 326 #endif
 327
 328  PUTBACK;
 329
 330  FREETMPS;
 331  LEAVE;
 332
 333  SvREFCNT_dec(ud->cb);
 334  SU_UD_FREE(ud);
 335 }
 336
 337 STATIC void su_reap(pTHX_ void *ud) {
 338 #define su_reap(U) su_reap(aTHX_ (U))
 339  SU_D({
 340   PerlIO_printf(Perl_debug_log,
 341                 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 342                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 343  });
 344
 345  SAVEDESTRUCTOR_X(su_call, ud);
 346 }
 347
 348 /* ... Localize & localize array/hash element .............................. */
 349
 350 typedef struct {
 351  su_ud_common ci;
 352  SV *sv;
 353  SV *val;
 354  SV *elem;
 355 } su_ud_localize;
 356
 357 STATIC void su_localize(pTHX_ void *ud_) {
 358 #define su_localize(U) su_localize(aTHX_ (U))
 359  su_ud_localize *ud = (su_ud_localize *) ud_;
 360  SV *sv   = ud->sv;
 361  SV *val  = ud->val;
 362  SV *elem = ud->elem;
 363  GV *gv;
 364  UV deref = 0;
 365  svtype t = SVt_NULL;
 366
 367  if (SvTYPE(sv) >= SVt_PVGV) {
 368   gv = (GV *) sv;
 369   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 370    t = SVt_PVGV;
 371   } else {                   /* local *x = \$val; */
 372    t = SvTYPE(SvRV(val));
 373    deref = 1;
 374   }
 375  } else {
 376   STRLEN len, l;
 377   const char *p = SvPV_const(sv, len), *s;
 378   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 379   if (!l) {
 380    l = len;
 381    s = p;
 382   }
 383   switch (*s) {
 384    case '$': t = SVt_PV;   break;
 385    case '@': t = SVt_PVAV; break;
 386    case '%': t = SVt_PVHV; break;
 387    case '&': t = SVt_PVCV; break;
 388    case '*': t = SVt_PVGV; break;
 389   }
 390   if (t != SVt_NULL) {
 391    ++s;
 392    --l;
 393   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 394    if (SvROK(val) && !sv_isobject(val)) {
 395     t = SvTYPE(SvRV(val));
 396     deref = 1;
 397    } else {
 398     t = SvTYPE(val);
 399    }
 400   }
 401   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
 402  }
 403
 404  SU_D({
 405   SV *z = newSV(0);
 406   SvUPGRADE(z, t);
 407   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 408   PerlIO_printf(Perl_debug_log,
 409                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 410                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 411   SvREFCNT_dec(z);
 412  });
 413
 414  /* Inspired from Alias.pm */
 415  switch (t) {
 416   case SVt_PVAV:
 417    if (elem) {
 418     su_save_aelem(GvAV(gv), elem, val);
 419     goto done;
 420    } else
 421     save_ary(gv);
 422    break;
 423   case SVt_PVHV:
 424    if (elem) {
 425     su_save_helem(GvHV(gv), elem, val);
 426     goto done;
 427    } else
 428     save_hash(gv);
 429    break;
 430   case SVt_PVGV:
 431    save_gp(gv, 1); /* hide previous entry in symtab */
 432    break;
 433   case SVt_PVCV:
 434    SAVESPTR(GvCV(gv));
 435    GvCV(gv) = NULL;
 436    break;
 437   default:
 438    gv = (GV *) save_scalar(gv);
 439    if (deref) /* val != NULL */
 440     val = SvRV(val);
 441    break;
 442  }
 443
 444  if (val)
 445   SvSetMagicSV((SV *) gv, val);
 446
 447 done:
 448  SvREFCNT_dec(ud->elem);
 449  SvREFCNT_dec(ud->val);
 450  SvREFCNT_dec(ud->sv);
 451  SU_UD_FREE(ud);
 452 }
 453
 454 /* --- Pop a context back -------------------------------------------------- */
 455
 456 #if SU_DEBUG
 457 # ifdef DEBUGGING
 458 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 459 # else
 460 #  define SU_CXNAME "XXX"
 461 # endif
 462 #endif
 463
 464 STATIC void su_pop(pTHX_ void *ud) {
 465 #define su_pop(U) su_pop(aTHX_ (U))
 466  I32 depth, base, mark, *origin;
 467  depth = SU_UD_DEPTH(ud);
 468
 469  SU_D({
 470   PerlIO_printf(Perl_debug_log, "%p: --- pop a %s\n", ud, SU_CXNAME);
 471   PerlIO_printf(Perl_debug_log,
 472     "%p: leave scope at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n", ud,
 473      depth, PL_scopestack_ix, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]);
 474  });
 475
 476  origin = SU_UD_ORIGIN(ud);
 477  mark   = origin[depth];
 478  base   = origin[depth - 1];
 479
 480  SU_D(PerlIO_printf(Perl_debug_log,
 481                     "%p: original scope was %*c top=%2d     base=%2d\n",
 482                      ud,                20, ' ',    mark,        base));
 483
 484  if (base < mark) {
 485   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
 486   PL_savestack_ix = mark;
 487   leave_scope(base);
 488  }
 489  PL_savestack_ix = base;
 490
 491  SU_UD_DEPTH(ud) = --depth;
 492
 493  if (depth > 0) {
 494   SU_D(PerlIO_printf(Perl_debug_log,
 495           "%p: set new destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
 496            ud,                       depth, PL_scopestack_ix, PL_savestack_ix));
 497
 498   SAVEDESTRUCTOR_X(su_pop, ud);
 499  } else {
 500   SU_UD_HANDLER(ud)(aTHX_ ud);
 501  }
 502
 503  SU_D(PerlIO_printf(Perl_debug_log,
 504                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
 505                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
 506 }
 507
 508 /* --- Initialize the stack and the action userdata ------------------------ */
 509
 510 STATIC I32 su_init(pTHX_ I32 cxix, void *ud, I32 size) {
 511 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 512  I32 i, depth = 0, *origin;
 513
 514  LEAVE_with_name("sub");
 515
 516  if (cxix >= cxstack_ix) {
 517   SU_UD_HANDLER(ud)(aTHX_ ud);
 518   goto done;
 519  }
 520
 521  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 522
 523  for (i = cxstack_ix; i > cxix; --i) {
 524   PERL_CONTEXT *cx = cxstack + i;
 525   switch (CxTYPE(cx)) {
 526 #if SU_HAS_PERL(5, 10, 0)
 527    case CXt_BLOCK:
 528     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
 529     /* Given and when blocks are actually followed by a simple block, so skip
 530      * it if needed. */
 531     if (cxix > 0) { /* Implies i > 0 */
 532      PERL_CONTEXT *next = cx - 1;
 533      if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
 534       --cxix;
 535     }
 536     depth++;
 537     break;
 538 #endif
 539 #if SU_HAS_PERL(5, 11, 0)
 540    case CXt_LOOP_FOR:
 541    case CXt_LOOP_PLAIN:
 542    case CXt_LOOP_LAZYSV:
 543    case CXt_LOOP_LAZYIV:
 544 #else
 545    case CXt_LOOP:
 546 #endif
 547     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 548     depth += 2;
 549     break;
 550    default:
 551     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
 552     depth++;
 553     break;
 554   }
 555  }
 556  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 557
 558  Newx(origin, depth + 1, I32);
 559  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 560  PL_scopestack[PL_scopestack_ix - depth] += size;
 561  for (i = depth - 1; i >= 1; --i) {
 562   I32 j = PL_scopestack_ix - i;
 563   origin[depth - i] = PL_scopestack[j];
 564   PL_scopestack[j] += 3;
 565  }
 566  origin[depth] = PL_savestack_ix;
 567
 568  SU_UD_ORIGIN(ud) = origin;
 569  SU_UD_DEPTH(ud)  = depth;
 570
 571  SU_D(PerlIO_printf(Perl_debug_log,
 572         "%p: set original destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
 573          ud,                     depth, PL_scopestack_ix - 1, PL_savestack_ix));
 574
 575  SAVEDESTRUCTOR_X(su_pop, ud);
 576
 577  SU_D({
 578   for (i = 0; i <= depth; ++i) {
 579    I32 j = PL_scopestack_ix  - i;
 580    PerlIO_printf(Perl_debug_log,
 581                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
 582                   ud,        i, j, origin[depth - i],
 583                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
 584   }
 585  });
 586
 587 done:
 588  ENTER_with_name("sub");
 589
 590  return depth;
 591 }
 592
 593 /* --- Global data --------------------------------------------------------- */
 594
 595 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 596
 597 typedef struct {
 598  I32 cxix;
 599  I32 items;
 600  SV  **savesp;
 601  OP  fakeop;
 602 } my_cxt_t;
 603
 604 START_MY_CXT
 605
 606 /* --- Unwind stack -------------------------------------------------------- */
 607
 608 STATIC void su_unwind(pTHX_ void *ud_) {
 609  dMY_CXT;
 610  I32 cxix    = MY_CXT.cxix;
 611  I32 items   = MY_CXT.items - 1;
 612  SV **savesp = MY_CXT.savesp;
 613  I32 mark;
 614
 615  PERL_UNUSED_VAR(ud_);
 616
 617  if (savesp)
 618   PL_stack_sp = savesp;
 619
 620  if (cxstack_ix > cxix)
 621   dounwind(cxix);
 622
 623  /* Hide the level */
 624  if (items >= 0)
 625   PL_stack_sp--;
 626
 627  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
 628  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
 629
 630  SU_D({
 631   I32 gimme = GIMME_V;
 632   PerlIO_printf(Perl_debug_log,
 633                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
 634                 &MY_CXT, cxix,
 635                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
 636                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
 637  });
 638
 639  PL_op = PL_ppaddr[OP_RETURN](aTHX);
 640  *PL_markstack_ptr = mark;
 641
 642  MY_CXT.fakeop.op_next = PL_op;
 643  PL_op = &(MY_CXT.fakeop);
 644 }
 645
 646 /* --- XS ------------------------------------------------------------------ */
 647
 648 #if SU_HAS_PERL(5, 8, 9)
 649 # define SU_SKIP_DB_MAX 2
 650 #else
 651 # define SU_SKIP_DB_MAX 3
 652 #endif
 653
 654 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
 655  * followed by a DB sub */
 656
 657 #define SU_SKIP_DB(C) \
 658  STMT_START {         \
 659   I32 i = 1;          \
 660   PERL_CONTEXT *cx = cxstack + (C); \
 661   do {                              \
 662    if (CxTYPE(cx) == CXt_BLOCK && (C) >= i) { \
 663     --cx;                                     \
 664     if (CxTYPE(cx) == CXt_SUB && cx->blk_sub.cv == GvCV(PL_DBsub)) { \
 665      (C) -= i + 1;                 \
 666      break;                        \
 667     }                              \
 668    } else                          \
 669     break;                         \
 670   } while (++i <= SU_SKIP_DB_MAX); \
 671  } STMT_END
 672
 673 #define SU_GET_CONTEXT(A, B)   \
 674  STMT_START {                  \
 675   if (items > A) {             \
 676    SV *csv = ST(B);            \
 677    if (!SvOK(csv))             \
 678     goto default_cx;           \
 679    cxix = SvIV(csv);           \
 680    if (cxix < 0)               \
 681     cxix = 0;                  \
 682    else if (cxix > cxstack_ix) \
 683     cxix = cxstack_ix;         \
 684   } else {                     \
 685 default_cx:                    \
 686    cxix = cxstack_ix;          \
 687    if (PL_DBsub)               \
 688     SU_SKIP_DB(cxix);          \
 689   }                            \
 690  } STMT_END
 691
 692 #define SU_GET_LEVEL(A, B) \
 693  STMT_START {              \
 694   level = 0;               \
 695   if (items > 0) {         \
 696    SV *lsv = ST(B);        \
 697    if (SvOK(lsv)) {        \
 698     level = SvIV(lsv);     \
 699     if (level < 0)         \
 700      level = 0;            \
 701    }                       \
 702   }                        \
 703  } STMT_END
 704
 705 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
 706
 707 XS(XS_Scope__Upper_unwind) {
 708 #ifdef dVAR
 709  dVAR; dXSARGS;
 710 #else
 711  dXSARGS;
 712 #endif
 713  dMY_CXT;
 714  I32 cxix;
 715
 716  PERL_UNUSED_VAR(cv); /* -W */
 717  PERL_UNUSED_VAR(ax); /* -Wall */
 718
 719  SU_GET_CONTEXT(0, items - 1);
 720  do {
 721   PERL_CONTEXT *cx = cxstack + cxix;
 722   switch (CxTYPE(cx)) {
 723    case CXt_SUB:
 724     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 725      continue;
 726    case CXt_EVAL:
 727    case CXt_FORMAT:
 728     MY_CXT.cxix  = cxix;
 729     MY_CXT.items = items;
 730     /* pp_entersub will want to sanitize the stack after returning from there
 731      * Screw that, we're insane */
 732     if (GIMME_V == G_SCALAR) {
 733      MY_CXT.savesp = PL_stack_sp;
 734      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
 735      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
 736     } else {
 737      MY_CXT.savesp = NULL;
 738     }
 739     SAVEDESTRUCTOR_X(su_unwind, NULL);
 740     return;
 741    default:
 742     break;
 743   }
 744  } while (--cxix >= 0);
 745  croak("Can't return outside a subroutine");
 746 }
 747
 748 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 749
 750 PROTOTYPES: ENABLE
 751
 752 BOOT:
 753 {
 754  HV *stash;
 755  MY_CXT_INIT;
 756  stash = gv_stashpv(__PACKAGE__, 1);
 757  newCONSTSUB(stash, "TOP",           newSViv(0));
 758  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
 759  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
 760 }
 761
 762 #if SU_THREADSAFE
 763
 764 void
 765 CLONE(...)
 766 PROTOTYPE: DISABLE
 767 CODE:
 768  PERL_UNUSED_VAR(items);
 769  {
 770   MY_CXT_CLONE;
 771  }
 772
 773 #endif /* SU_THREADSAFE */
 774
 775 SV *
 776 HERE()
 777 PROTOTYPE:
 778 PREINIT:
 779  I32 cxix = cxstack_ix;
 780 CODE:
 781  if (PL_DBsub)
 782   SU_SKIP_DB(cxix);
 783  RETVAL = newSViv(cxix);
 784 OUTPUT:
 785  RETVAL
 786
 787 SV *
 788 UP(...)
 789 PROTOTYPE: ;$
 790 PREINIT:
 791  I32 cxix;
 792 CODE:
 793  SU_GET_CONTEXT(0, 0);
 794  if (--cxix < 0)
 795   cxix = 0;
 796  if (PL_DBsub)
 797   SU_SKIP_DB(cxix);
 798  RETVAL = newSViv(cxix);
 799 OUTPUT:
 800  RETVAL
 801
 802 void
 803 SUB(...)
 804 PROTOTYPE: ;$
 805 PREINIT:
 806  I32 cxix;
 807 PPCODE:
 808  SU_GET_CONTEXT(0, 0);
 809  for (; cxix >= 0; --cxix) {
 810   PERL_CONTEXT *cx = cxstack + cxix;
 811   switch (CxTYPE(cx)) {
 812    default:
 813     continue;
 814    case CXt_SUB:
 815     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 816      continue;
 817     ST(0) = sv_2mortal(newSViv(cxix));
 818     XSRETURN(1);
 819   }
 820  }
 821  XSRETURN_UNDEF;
 822
 823 void
 824 EVAL(...)
 825 PROTOTYPE: ;$
 826 PREINIT:
 827  I32 cxix;
 828 PPCODE:
 829  SU_GET_CONTEXT(0, 0);
 830  for (; cxix >= 0; --cxix) {
 831   PERL_CONTEXT *cx = cxstack + cxix;
 832   switch (CxTYPE(cx)) {
 833    default:
 834     continue;
 835    case CXt_EVAL:
 836     ST(0) = sv_2mortal(newSViv(cxix));
 837     XSRETURN(1);
 838   }
 839  }
 840  XSRETURN_UNDEF;
 841
 842 void
 843 SCOPE(...)
 844 PROTOTYPE: ;$
 845 PREINIT:
 846  I32 cxix, level;
 847 PPCODE:
 848  SU_GET_LEVEL(0, 0);
 849  cxix = cxstack_ix;
 850  if (PL_DBsub) {
 851   SU_SKIP_DB(cxix);
 852   while (cxix > 0) {
 853    if (--level < 0)
 854     break;
 855    --cxix;
 856    SU_SKIP_DB(cxix);
 857   }
 858  } else {
 859   cxix -= level;
 860   if (cxix < 0)
 861    cxix = 0;
 862  }
 863  ST(0) = sv_2mortal(newSViv(cxix));
 864  XSRETURN(1);
 865
 866 void
 867 CALLER(...)
 868 PROTOTYPE: ;$
 869 PREINIT:
 870  I32 cxix, level;
 871 PPCODE:
 872  SU_GET_LEVEL(0, 0);
 873  for (cxix = cxstack_ix; cxix > 0; --cxix) {
 874   PERL_CONTEXT *cx = cxstack + cxix;
 875   switch (CxTYPE(cx)) {
 876    case CXt_SUB:
 877     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 878      continue;
 879    case CXt_EVAL:
 880    case CXt_FORMAT:
 881     if (--level < 0)
 882      goto done;
 883     break;
 884   }
 885  }
 886 done:
 887  ST(0) = sv_2mortal(newSViv(cxix));
 888  XSRETURN(1);
 889
 890 void
 891 want_at(...)
 892 PROTOTYPE: ;$
 893 PREINIT:
 894  I32 cxix;
 895 PPCODE:
 896  SU_GET_CONTEXT(0, 0);
 897  while (cxix > 0) {
 898   PERL_CONTEXT *cx = cxstack + cxix--;
 899   switch (CxTYPE(cx)) {
 900    case CXt_SUB:
 901    case CXt_EVAL:
 902    case CXt_FORMAT: {
 903     I32 gimme = cx->blk_gimme;
 904     switch (gimme) {
 905      case G_VOID:   XSRETURN_UNDEF; break;
 906      case G_SCALAR: XSRETURN_NO;    break;
 907      case G_ARRAY:  XSRETURN_YES;   break;
 908     }
 909     break;
 910    }
 911   }
 912  }
 913  XSRETURN_UNDEF;
 914
 915 void
 916 reap(SV *hook, ...)
 917 PROTOTYPE: &;$
 918 PREINIT:
 919  I32 cxix;
 920  su_ud_reap *ud;
 921 CODE:
 922  SU_GET_CONTEXT(1, 1);
 923  Newx(ud, 1, su_ud_reap);
 924  SU_UD_ORIGIN(ud)  = NULL;
 925  SU_UD_HANDLER(ud) = su_reap;
 926  ud->cb = newSVsv(hook);
 927  su_init(cxix, ud, 3);
 928
 929 void
 930 localize(SV *sv, SV *val, ...)
 931 PROTOTYPE: $$;$
 932 PREINIT:
 933  I32 cxix;
 934  su_ud_localize *ud;
 935 CODE:
 936  SU_GET_CONTEXT(2, 2);
 937  Newx(ud, 1, su_ud_localize);
 938  SU_UD_ORIGIN(ud)  = NULL;
 939  SU_UD_HANDLER(ud) = su_localize;
 940  SvREFCNT_inc(sv);
 941  ud->sv   = sv;
 942  ud->val  = newSVsv(val);
 943  ud->elem = NULL;
 944  su_init(cxix, ud, 3);
 945
 946 void
 947 localize_elem(SV *sv, SV *elem, SV *val, ...)
 948 PROTOTYPE: $$$;$
 949 PREINIT:
 950  I32 cxix;
 951  su_ud_localize *ud;
 952 CODE:
 953  SU_GET_CONTEXT(3, 3);
 954  Newx(ud, 1, su_ud_localize);
 955  SU_UD_ORIGIN(ud)  = NULL;
 956  SU_UD_HANDLER(ud) = su_localize;
 957  SvREFCNT_inc(sv);
 958  ud->sv   = sv;
 959  ud->val  = newSVsv(val);
 960  SvREFCNT_inc(elem);
 961  ud->elem = elem;
 962  su_init(cxix, ud, 4);
 963
 964 void
 965 localize_delete(SV *sv, SV *elem, ...)
 966 PROTOTYPE: $$;$
 967 PREINIT:
 968  I32 cxix;
 969  su_ud_localize *ud;
 970 CODE:
 971  SU_GET_CONTEXT(2, 2);
 972  Newx(ud, 1, su_ud_localize);
 973  SU_UD_ORIGIN(ud)  = NULL;
 974  SU_UD_HANDLER(ud) = su_localize;
 975  SvREFCNT_inc(sv);
 976  ud->sv   = sv;
 977  ud->val  = NULL;
 978  SvREFCNT_inc(elem);
 979  ud->elem = elem;
 980  su_init(cxix, ud, 4);