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(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
 297                                      ud, PL_scopestack_ix, PL_savestack_ix));
 298  ENTER;
 299  SAVETMPS;
 300
 301  PUSHMARK(SP);
 302  PUTBACK;
 303
 304  /* If the recently popped context isn't saved there, it will be overwritten by
 305   * the sub scope from call_sv, although it's still needed in our caller. */
 306
 307 #if SU_HAS_PERL(5, 9, 5)
 308  if (dieing) {
 309   if (cxstack_ix < cxstack_max)
 310    cxix = cxstack_ix + 1;
 311   else
 312    cxix = Perl_cxinc(aTHX);
 313   saved_cx = cxstack[cxix];
 314  }
 315 #endif
 316
 317  call_sv(ud->cb, G_VOID);
 318
 319 #if SU_HAS_PERL(5, 9, 5)
 320  if (dieing)
 321   cxstack[cxix] = saved_cx;
 322 #endif
 323
 324  PUTBACK;
 325
 326  FREETMPS;
 327  LEAVE;
 328
 329  SvREFCNT_dec(ud->cb);
 330  SU_UD_FREE(ud);
 331 }
 332
 333 STATIC void su_reap(pTHX_ void *ud) {
 334 #define su_reap(U) su_reap(aTHX_ (U))
 335  SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
 336                                      ud, PL_scopestack_ix, PL_savestack_ix));
 337  SAVEDESTRUCTOR_X(su_call, ud);
 338  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 339                                      ud, PL_savestack_ix,
 340                                          PL_scopestack[PL_scopestack_ix]));
 341 }
 342
 343 /* ... Localize & localize array/hash element .............................. */
 344
 345 typedef struct {
 346  su_ud_common ci;
 347  SV *sv;
 348  SV *val;
 349  SV *elem;
 350 } su_ud_localize;
 351
 352 STATIC void su_localize(pTHX_ void *ud_) {
 353 #define su_localize(U) su_localize(aTHX_ (U))
 354  su_ud_localize *ud = (su_ud_localize *) ud_;
 355  SV *sv   = ud->sv;
 356  SV *val  = ud->val;
 357  SV *elem = ud->elem;
 358  GV *gv;
 359  UV deref = 0;
 360  svtype t = SVt_NULL;
 361
 362  if (SvTYPE(sv) >= SVt_PVGV) {
 363   gv = (GV *) sv;
 364   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 365    t = SVt_PVGV;
 366   } else {                   /* local *x = \$val; */
 367    t = SvTYPE(SvRV(val));
 368    deref = 1;
 369   }
 370  } else {
 371   STRLEN len, l;
 372   const char *p = SvPV_const(sv, len), *s;
 373   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 374   if (!l) {
 375    l = len;
 376    s = p;
 377   }
 378   switch (*s) {
 379    case '$': t = SVt_PV;   break;
 380    case '@': t = SVt_PVAV; break;
 381    case '%': t = SVt_PVHV; break;
 382    case '&': t = SVt_PVCV; break;
 383    case '*': t = SVt_PVGV; break;
 384   }
 385   if (t != SVt_NULL) {
 386    ++s;
 387    --l;
 388   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 389    if (SvROK(val) && !sv_isobject(val)) {
 390     t = SvTYPE(SvRV(val));
 391     deref = 1;
 392    } else {
 393     t = SvTYPE(val);
 394    }
 395   }
 396   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
 397  }
 398
 399  SU_D({
 400   SV *z = newSV(0);
 401   SvUPGRADE(z, t);
 402   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
 403                                  ud, sv_reftype(z, 0),
 404                                      PL_scopestack_ix, PL_savestack_ix);
 405   SvREFCNT_dec(z);
 406  });
 407
 408  /* Inspired from Alias.pm */
 409  switch (t) {
 410   case SVt_PVAV:
 411    if (elem) {
 412     su_save_aelem(GvAV(gv), elem, val);
 413     goto done;
 414    } else
 415     save_ary(gv);
 416    break;
 417   case SVt_PVHV:
 418    if (elem) {
 419     su_save_helem(GvHV(gv), elem, val);
 420     goto done;
 421    } else
 422     save_hash(gv);
 423    break;
 424   case SVt_PVGV:
 425    save_gp(gv, 1); /* hide previous entry in symtab */
 426    break;
 427   case SVt_PVCV:
 428    SAVESPTR(GvCV(gv));
 429    GvCV(gv) = NULL;
 430    break;
 431   default:
 432    gv = (GV *) save_scalar(gv);
 433    if (deref) /* val != NULL */
 434     val = SvRV(val);
 435    break;
 436  }
 437
 438  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 439                                      ud, PL_savestack_ix,
 440                                          PL_scopestack[PL_scopestack_ix]));
 441
 442  if (val)
 443   SvSetMagicSV((SV *) gv, val);
 444
 445 done:
 446  SvREFCNT_dec(ud->elem);
 447  SvREFCNT_dec(ud->val);
 448  SvREFCNT_dec(ud->sv);
 449  SU_UD_FREE(ud);
 450 }
 451
 452 /* --- Pop a context back -------------------------------------------------- */
 453
 454 #if SU_DEBUG
 455 # ifdef DEBUGGING
 456 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 457 # else
 458 #  define SU_CXNAME "XXX"
 459 # endif
 460 #endif
 461
 462 STATIC void su_pop(pTHX_ void *ud) {
 463 #define su_pop(U) su_pop(aTHX_ (U))
 464  I32 depth, base, mark, *origin;
 465  depth = SU_UD_DEPTH(ud);
 466
 467  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
 468                                      ud, SU_CXNAME,
 469                                          PL_scopestack_ix, PL_savestack_ix,
 470                                          PL_scopestack[PL_scopestack_ix],
 471                                          depth));
 472
 473  origin = SU_UD_ORIGIN(ud);
 474  mark   = origin[depth];
 475  base   = origin[depth - 1];
 476
 477  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
 478                                      ud, mark, base));
 479
 480  if (base < mark) {
 481   PL_savestack_ix = mark;
 482   leave_scope(base);
 483  }
 484  PL_savestack_ix = base;
 485  if (--depth > 0) {
 486   SU_UD_DEPTH(ud) = depth;
 487   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
 488                                       ud, PL_savestack_ix, depth));
 489   SAVEDESTRUCTOR_X(su_pop, ud);
 490   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
 491                                       ud, PL_savestack_ix, depth));
 492  } else {
 493   SU_UD_HANDLER(ud)(aTHX_ ud);
 494 #if SU_DEBUG
 495   if (PL_scopestack[PL_scopestack_ix] != PL_savestack_ix)
 496    PerlIO_printf(Perl_debug_log, "%p: expected: %2d got: %2d\n", ud, PL_scopestack_ix, PL_savestack_ix);
 497 #endif /* SU_DEBUG */
 498  }
 499 }
 500
 501 /* --- Initialize the stack and the action userdata ------------------------ */
 502
 503 STATIC I32 su_init(pTHX_ I32 cxix, void *ud, I32 size) {
 504 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 505  I32 i, depth = 0, *origin;
 506
 507  LEAVE_with_name("sub");
 508
 509  if (cxix >= cxstack_ix) {
 510   SU_UD_HANDLER(ud)(aTHX_ ud);
 511   goto done;
 512  }
 513
 514  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 515
 516  for (i = cxstack_ix; i > cxix; --i) {
 517   PERL_CONTEXT *cx = cxstack + i;
 518   switch (CxTYPE(cx)) {
 519 #if SU_HAS_PERL(5, 10, 0)
 520    case CXt_BLOCK:
 521     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
 522     /* Given and when blocks are actually followed by a simple block, so skip
 523      * it if needed. */
 524     if (cxix > 0) { /* Implies i > 0 */
 525      PERL_CONTEXT *next = cx - 1;
 526      if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
 527       --cxix;
 528     }
 529     depth++;
 530     break;
 531 #endif
 532 #if SU_HAS_PERL(5, 11, 0)
 533    case CXt_LOOP_FOR:
 534    case CXt_LOOP_PLAIN:
 535    case CXt_LOOP_LAZYSV:
 536    case CXt_LOOP_LAZYIV:
 537 #else
 538    case CXt_LOOP:
 539 #endif
 540     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 541     depth += 2;
 542     break;
 543    default:
 544     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
 545     depth++;
 546     break;
 547   }
 548  }
 549  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 550
 551  Newx(origin, depth + 1, I32);
 552  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 553  PL_scopestack[PL_scopestack_ix - depth] += size;
 554  for (i = depth - 1; i >= 1; --i) {
 555   I32 j = PL_scopestack_ix - i;
 556   origin[depth - i] = PL_scopestack[j];
 557   PL_scopestack[j] += 3;
 558  }
 559  origin[depth] = PL_savestack_ix;
 560
 561  SU_D({
 562   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 563                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
 564   for (i = depth - 1; i >= 0; --i) {
 565    I32 x = PL_scopestack_ix  - depth + i;
 566    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 567                                   i, depth - i, x, PL_scopestack[x], origin[i]);
 568   }
 569  });
 570
 571  SU_UD_ORIGIN(ud) = origin;
 572  SU_UD_DEPTH(ud)  = depth;
 573
 574  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 575                                      ud, PL_savestack_ix, depth));
 576
 577  SAVEDESTRUCTOR_X(su_pop, ud);
 578
 579 done:
 580  ENTER_with_name("sub");
 581
 582  return depth;
 583 }
 584
 585 /* --- Global data --------------------------------------------------------- */
 586
 587 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 588
 589 typedef struct {
 590  I32 cxix;
 591  I32 items;
 592  SV  **savesp;
 593  OP  fakeop;
 594 } my_cxt_t;
 595
 596 START_MY_CXT
 597
 598 /* --- Unwind stack -------------------------------------------------------- */
 599
 600 STATIC void su_unwind(pTHX_ void *ud_) {
 601  dMY_CXT;
 602  I32 cxix    = MY_CXT.cxix;
 603  I32 items   = MY_CXT.items - 1;
 604  SV **savesp = MY_CXT.savesp;
 605  I32 mark;
 606
 607  PERL_UNUSED_VAR(ud_);
 608
 609  if (savesp)
 610   PL_stack_sp = savesp;
 611
 612  if (cxstack_ix > cxix)
 613   dounwind(cxix);
 614
 615  /* Hide the level */
 616  if (items >= 0)
 617   PL_stack_sp--;
 618
 619  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
 620  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
 621
 622  SU_D({
 623   I32 gimme = GIMME_V;
 624   PerlIO_printf(Perl_debug_log,
 625                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
 626                 &MY_CXT, cxix,
 627                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
 628                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
 629  });
 630
 631  PL_op = PL_ppaddr[OP_RETURN](aTHX);
 632  *PL_markstack_ptr = mark;
 633
 634  MY_CXT.fakeop.op_next = PL_op;
 635  PL_op = &(MY_CXT.fakeop);
 636 }
 637
 638 /* --- XS ------------------------------------------------------------------ */
 639
 640 #if SU_HAS_PERL(5, 8, 9)
 641 # define SU_SKIP_DB_MAX 2
 642 #else
 643 # define SU_SKIP_DB_MAX 3
 644 #endif
 645
 646 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
 647  * followed by a DB sub */
 648
 649 #define SU_SKIP_DB(C) \
 650  STMT_START {         \
 651   I32 i = 1;          \
 652   PERL_CONTEXT *cx = cxstack + (C); \
 653   do {                              \
 654    if (CxTYPE(cx) == CXt_BLOCK && (C) >= i) { \
 655     --cx;                                     \
 656     if (CxTYPE(cx) == CXt_SUB && cx->blk_sub.cv == GvCV(PL_DBsub)) { \
 657      (C) -= i + 1;                 \
 658      break;                        \
 659     }                              \
 660    } else                          \
 661     break;                         \
 662   } while (++i <= SU_SKIP_DB_MAX); \
 663  } STMT_END
 664
 665 #define SU_GET_CONTEXT(A, B)   \
 666  STMT_START {                  \
 667   if (items > A) {             \
 668    SV *csv = ST(B);            \
 669    if (!SvOK(csv))             \
 670     goto default_cx;           \
 671    cxix = SvIV(csv);           \
 672    if (cxix < 0)               \
 673     cxix = 0;                  \
 674    else if (cxix > cxstack_ix) \
 675     cxix = cxstack_ix;         \
 676   } else {                     \
 677 default_cx:                    \
 678    cxix = cxstack_ix;          \
 679    if (PL_DBsub)               \
 680     SU_SKIP_DB(cxix);          \
 681   }                            \
 682  } STMT_END
 683
 684 #define SU_GET_LEVEL(A, B) \
 685  STMT_START {              \
 686   level = 0;               \
 687   if (items > 0) {         \
 688    SV *lsv = ST(B);        \
 689    if (SvOK(lsv)) {        \
 690     level = SvIV(lsv);     \
 691     if (level < 0)         \
 692      level = 0;            \
 693    }                       \
 694   }                        \
 695  } STMT_END
 696
 697 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
 698
 699 XS(XS_Scope__Upper_unwind) {
 700 #ifdef dVAR
 701  dVAR; dXSARGS;
 702 #else
 703  dXSARGS;
 704 #endif
 705  dMY_CXT;
 706  I32 cxix;
 707
 708  PERL_UNUSED_VAR(cv); /* -W */
 709  PERL_UNUSED_VAR(ax); /* -Wall */
 710
 711  SU_GET_CONTEXT(0, items - 1);
 712  do {
 713   PERL_CONTEXT *cx = cxstack + cxix;
 714   switch (CxTYPE(cx)) {
 715    case CXt_SUB:
 716     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 717      continue;
 718    case CXt_EVAL:
 719    case CXt_FORMAT:
 720     MY_CXT.cxix  = cxix;
 721     MY_CXT.items = items;
 722     /* pp_entersub will want to sanitize the stack after returning from there
 723      * Screw that, we're insane */
 724     if (GIMME_V == G_SCALAR) {
 725      MY_CXT.savesp = PL_stack_sp;
 726      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
 727      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
 728     } else {
 729      MY_CXT.savesp = NULL;
 730     }
 731     SAVEDESTRUCTOR_X(su_unwind, NULL);
 732     return;
 733    default:
 734     break;
 735   }
 736  } while (--cxix >= 0);
 737  croak("Can't return outside a subroutine");
 738 }
 739
 740 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 741
 742 PROTOTYPES: ENABLE
 743
 744 BOOT:
 745 {
 746  HV *stash;
 747  MY_CXT_INIT;
 748  stash = gv_stashpv(__PACKAGE__, 1);
 749  newCONSTSUB(stash, "TOP",           newSViv(0));
 750  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
 751  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
 752 }
 753
 754 #if SU_THREADSAFE
 755
 756 void
 757 CLONE(...)
 758 PROTOTYPE: DISABLE
 759 CODE:
 760  PERL_UNUSED_VAR(items);
 761  {
 762   MY_CXT_CLONE;
 763  }
 764
 765 #endif /* SU_THREADSAFE */
 766
 767 SV *
 768 HERE()
 769 PROTOTYPE:
 770 PREINIT:
 771  I32 cxix = cxstack_ix;
 772 CODE:
 773  if (PL_DBsub)
 774   SU_SKIP_DB(cxix);
 775  RETVAL = newSViv(cxix);
 776 OUTPUT:
 777  RETVAL
 778
 779 SV *
 780 UP(...)
 781 PROTOTYPE: ;$
 782 PREINIT:
 783  I32 cxix;
 784 CODE:
 785  SU_GET_CONTEXT(0, 0);
 786  if (--cxix < 0)
 787   cxix = 0;
 788  if (PL_DBsub)
 789   SU_SKIP_DB(cxix);
 790  RETVAL = newSViv(cxix);
 791 OUTPUT:
 792  RETVAL
 793
 794 void
 795 SUB(...)
 796 PROTOTYPE: ;$
 797 PREINIT:
 798  I32 cxix;
 799 PPCODE:
 800  SU_GET_CONTEXT(0, 0);
 801  for (; cxix >= 0; --cxix) {
 802   PERL_CONTEXT *cx = cxstack + cxix;
 803   switch (CxTYPE(cx)) {
 804    default:
 805     continue;
 806    case CXt_SUB:
 807     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 808      continue;
 809     ST(0) = sv_2mortal(newSViv(cxix));
 810     XSRETURN(1);
 811   }
 812  }
 813  XSRETURN_UNDEF;
 814
 815 void
 816 EVAL(...)
 817 PROTOTYPE: ;$
 818 PREINIT:
 819  I32 cxix;
 820 PPCODE:
 821  SU_GET_CONTEXT(0, 0);
 822  for (; cxix >= 0; --cxix) {
 823   PERL_CONTEXT *cx = cxstack + cxix;
 824   switch (CxTYPE(cx)) {
 825    default:
 826     continue;
 827    case CXt_EVAL:
 828     ST(0) = sv_2mortal(newSViv(cxix));
 829     XSRETURN(1);
 830   }
 831  }
 832  XSRETURN_UNDEF;
 833
 834 void
 835 SCOPE(...)
 836 PROTOTYPE: ;$
 837 PREINIT:
 838  I32 cxix, level;
 839 PPCODE:
 840  SU_GET_LEVEL(0, 0);
 841  cxix = cxstack_ix;
 842  if (PL_DBsub) {
 843   SU_SKIP_DB(cxix);
 844   while (cxix > 0) {
 845    if (--level < 0)
 846     break;
 847    --cxix;
 848    SU_SKIP_DB(cxix);
 849   }
 850  } else {
 851   cxix -= level;
 852   if (cxix < 0)
 853    cxix = 0;
 854  }
 855  ST(0) = sv_2mortal(newSViv(cxix));
 856  XSRETURN(1);
 857
 858 void
 859 CALLER(...)
 860 PROTOTYPE: ;$
 861 PREINIT:
 862  I32 cxix, level;
 863 PPCODE:
 864  SU_GET_LEVEL(0, 0);
 865  for (cxix = cxstack_ix; cxix > 0; --cxix) {
 866   PERL_CONTEXT *cx = cxstack + cxix;
 867   switch (CxTYPE(cx)) {
 868    case CXt_SUB:
 869     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 870      continue;
 871    case CXt_EVAL:
 872    case CXt_FORMAT:
 873     if (--level < 0)
 874      goto done;
 875     break;
 876   }
 877  }
 878 done:
 879  ST(0) = sv_2mortal(newSViv(cxix));
 880  XSRETURN(1);
 881
 882 void
 883 want_at(...)
 884 PROTOTYPE: ;$
 885 PREINIT:
 886  I32 cxix;
 887 PPCODE:
 888  SU_GET_CONTEXT(0, 0);
 889  while (cxix > 0) {
 890   PERL_CONTEXT *cx = cxstack + cxix--;
 891   switch (CxTYPE(cx)) {
 892    case CXt_SUB:
 893    case CXt_EVAL:
 894    case CXt_FORMAT: {
 895     I32 gimme = cx->blk_gimme;
 896     switch (gimme) {
 897      case G_VOID:   XSRETURN_UNDEF; break;
 898      case G_SCALAR: XSRETURN_NO;    break;
 899      case G_ARRAY:  XSRETURN_YES;   break;
 900     }
 901     break;
 902    }
 903   }
 904  }
 905  XSRETURN_UNDEF;
 906
 907 void
 908 reap(SV *hook, ...)
 909 PROTOTYPE: &;$
 910 PREINIT:
 911  I32 cxix;
 912  su_ud_reap *ud;
 913 CODE:
 914  SU_GET_CONTEXT(1, 1);
 915  Newx(ud, 1, su_ud_reap);
 916  SU_UD_ORIGIN(ud)  = NULL;
 917  SU_UD_HANDLER(ud) = su_reap;
 918  ud->cb = newSVsv(hook);
 919  su_init(cxix, ud, 3);
 920
 921 void
 922 localize(SV *sv, SV *val, ...)
 923 PROTOTYPE: $$;$
 924 PREINIT:
 925  I32 cxix;
 926  su_ud_localize *ud;
 927 CODE:
 928  SU_GET_CONTEXT(2, 2);
 929  Newx(ud, 1, su_ud_localize);
 930  SU_UD_ORIGIN(ud)  = NULL;
 931  SU_UD_HANDLER(ud) = su_localize;
 932  SvREFCNT_inc(sv);
 933  ud->sv   = sv;
 934  ud->val  = newSVsv(val);
 935  ud->elem = NULL;
 936  su_init(cxix, ud, 3);
 937
 938 void
 939 localize_elem(SV *sv, SV *elem, SV *val, ...)
 940 PROTOTYPE: $$$;$
 941 PREINIT:
 942  I32 cxix;
 943  su_ud_localize *ud;
 944 CODE:
 945  SU_GET_CONTEXT(3, 3);
 946  Newx(ud, 1, su_ud_localize);
 947  SU_UD_ORIGIN(ud)  = NULL;
 948  SU_UD_HANDLER(ud) = su_localize;
 949  SvREFCNT_inc(sv);
 950  ud->sv   = sv;
 951  ud->val  = newSVsv(val);
 952  SvREFCNT_inc(elem);
 953  ud->elem = elem;
 954  su_init(cxix, ud, 4);
 955
 956 void
 957 localize_delete(SV *sv, SV *elem, ...)
 958 PROTOTYPE: $$;$
 959 PREINIT:
 960  I32 cxix;
 961  su_ud_localize *ud;
 962 CODE:
 963  SU_GET_CONTEXT(2, 2);
 964  Newx(ud, 1, su_ud_localize);
 965  SU_UD_ORIGIN(ud)  = NULL;
 966  SU_UD_HANDLER(ud) = su_localize;
 967  SvREFCNT_inc(sv);
 968  ud->sv   = sv;
 969  ud->val  = NULL;
 970  SvREFCNT_inc(elem);
 971  ud->elem = elem;
 972  su_init(cxix, ud, 4);