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